Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow server to produce data telemetry #3150

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

vinistock
Copy link
Member

@vinistock vinistock commented Feb 7, 2025

Motivation

Allow the server to produce data telemetry, in addition to error telemetry. This is useful for both the server and add-ons to track adoption of certain features or how they are used.

Here's an example of how it would be used.

Notification.telemetry(type: "data", eventName: "tapioca.dsl", data: { type: "counter" })

Implementation

Just added a branch for the data telemetry. Since the server and add-ons can send arbitrary data, I added runtime validation to prevent sending bad data to telemetry.

Automated Tests

It's unfortunately not possible to test this because the client doesn't expose a way to fake an incoming notification. I did test it manually though.

Copy link
Member Author


How to use the Graphite Merge Queue

Add the label graphite-merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@vinistock vinistock added vscode This pull request should be included in the VS Code extension's release notes other Changes that aren't bugfixes, enhancements or breaking changes labels Feb 7, 2025 — with Graphite App
@vinistock vinistock self-assigned this Feb 7, 2025
@vinistock vinistock requested review from KaanOzkan and andyw8 February 7, 2025 16:56
@vinistock vinistock marked this pull request as ready for review February 7, 2025 16:58
@vinistock vinistock requested a review from a team as a code owner February 7, 2025 16:58
@vinistock vinistock added the graphite-merge Ship this PR using Graphite's merge queue label Feb 7, 2025
Copy link
Member Author

vinistock commented Feb 7, 2025

Merge activity

  • Feb 7, 12:21 PM EST: The merge label 'graphite-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
  • Feb 7, 12:23 PM EST: A user added this pull request to the Graphite merge queue.
  • Feb 7, 12:50 PM EST: A user merged this pull request with the Graphite merge queue.

### Motivation

Allow the server to produce data telemetry, in addition to error telemetry. This is useful for both the server and add-ons to track adoption of certain features or how they are used.

Here's an example of how it would be used.
```ruby
Notification.telemetry(type: "data", eventName: "tapioca.dsl", data: { type: "counter" })
```

### Implementation

Just added a branch for the data telemetry. Since the server and add-ons can send arbitrary data, I added runtime validation to prevent sending bad data to telemetry.

### Automated Tests

It's unfortunately not possible to test this because the client doesn't expose a way to fake an incoming notification. I did test it manually though.
@graphite-app graphite-app bot force-pushed the 02-07-allow_server_to_produce_data_telemetry branch from e67e32e to 583e72a Compare February 7, 2025 17:24
@graphite-app graphite-app bot merged commit 583e72a into main Feb 7, 2025
42 checks passed
@graphite-app graphite-app bot deleted the 02-07-allow_server_to_produce_data_telemetry branch February 7, 2025 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
graphite-merge Ship this PR using Graphite's merge queue other Changes that aren't bugfixes, enhancements or breaking changes vscode This pull request should be included in the VS Code extension's release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants