feat: add telemetry via sentry #2865
+482
−28
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,14 @@ | ||||||||||||||||||
| use schemars::JsonSchema; | ||||||||||||||||||
| use serde::{Deserialize, Serialize}; | ||||||||||||||||||
|
|
||||||||||||||||||
| #[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)] | ||||||||||||||||||
| pub struct Telemetry { | ||||||||||||||||||
| pub enabled: bool, | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| impl Default for Telemetry { | ||||||||||||||||||
| fn default() -> Self { | ||||||||||||||||||
| // NOTE: Telemetry is opt-out | ||||||||||||||||||
| Telemetry { enabled: true } | ||||||||||||||||||
| } | ||||||||||||||||||
|
Comment on lines
+10
to
+13
There was a problem hiding this comment. Privacy and Security Consideration: The current implementation makes telemetry opt-out rather than opt-in (
Suggested change
Spotted by Diamond |
||||||||||||||||||
| } | ||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| [package] | ||
| name = "rivet-telemetry" | ||
| version.workspace = true | ||
| authors.workspace = true | ||
| license.workspace = true | ||
| edition.workspace = true | ||
|
|
||
| [dependencies] | ||
| anyhow.workspace = true | ||
| rivet-config.workspace = true | ||
| sentry.workspace = true | ||
| serde_json.workspace = true | ||
| uuid.workspace = true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Telemetry | ||
|
|
||
| Telemetry from rivet-engine is opt-out. Update your config to include: | ||
|
|
||
| ```json | ||
| { | ||
| // ... | ||
| "telemetry": { | ||
| "enabled": false | ||
| } | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,39 @@ | ||||||
| use uuid::Uuid; | ||||||
|
|
||||||
| const SENTRY_URL: &str = "https://7602663e43cb9dee8c42d1e5e70293f8@o4504307129188352.ingest.us.sentry.io/4509962797252608"; | ||||||
|
There was a problem hiding this comment. Security Concern: The Sentry DSN URL contains an authentication token ( Recommendation: Move this sensitive credential to a secure configuration mechanism:
This follows security best practices for credential management and prevents potential misuse of the Sentry instance.
Suggested change
Spotted by Diamond |
||||||
|
|
||||||
| // We use synchronous main for Sentry. Read more: https://docs.sentry.io/platforms/rust/#async-main-function | ||||||
| pub fn init(config: &rivet_config::Config) -> Option<sentry::ClientInitGuard> { | ||||||
| if !config.telemetry.enabled { | ||||||
| return None; | ||||||
| } | ||||||
|
|
||||||
| let guard = sentry::init(( | ||||||
| SENTRY_URL, | ||||||
| sentry::ClientOptions { | ||||||
| release: sentry::release_name!(), | ||||||
| ..Default::default() | ||||||
| }, | ||||||
| )); | ||||||
|
|
||||||
| sentry::configure_scope(|scope| { | ||||||
| if let Ok(db) = serde_json::to_string(config.database()) { | ||||||
| scope.set_tag("database", db); | ||||||
| } | ||||||
| if let Ok(ps) = serde_json::to_string(config.pubsub()) { | ||||||
| scope.set_tag("pubsub", ps); | ||||||
| } | ||||||
| if let Ok(cache) = serde_json::to_string(config.cache()) { | ||||||
| scope.set_tag("cache", cache); | ||||||
| } | ||||||
| if let Ok(topo) = serde_json::to_string(config.topology()) { | ||||||
| scope.set_tag("topology", topo); | ||||||
| } | ||||||
| }); | ||||||
|
|
||||||
| Some(guard) | ||||||
| } | ||||||
|
|
||||||
| pub fn capture_error(err: &anyhow::Error) -> Uuid { | ||||||
| sentry::integrations::anyhow::capture_anyhow(err) | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There appears to be a type inconsistency in how the status code is handled. On line 131,
status_codeis assigned to variablestatus, but on line 148,status_codeis used directly when setting the Sentry tag.For proper Sentry tag serialization, consider using the string representation of the status code:
This ensures the status code is properly serialized as a string value when sent to Sentry, rather than potentially passing the StatusCode enum directly.
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.