Allow setting the Sentry environment & sample rates

Also record the version in the Sentry release field.

Author: sandhose

crates/cli/src/main.rs

@@ -119,7 +119,10 @@ async fn try_main() -> anyhow::Result<ExitCode> {
         telemetry_config.sentry.dsn.as_deref(),
         sentry::ClientOptions {
             transport: Some(Arc::new(SentryTransportFactory::new())),
-            traces_sample_rate: 1.0,
+            environment: telemetry_config.sentry.environment.clone().map(Into::into),
+            release: Some(VERSION.into()),
+            sample_rate: telemetry_config.sentry.sample_rate.unwrap_or(1.0),
+            traces_sample_rate: telemetry_config.sentry.traces_sample_rate.unwrap_or(0.0),
             auto_session_tracking: true,
             session_mode: sentry::SessionMode::Request,
             ..Default::default()

crates/config/src/sections/telemetry.rs

@@ -5,12 +5,16 @@
 // Please see LICENSE in the repository root for full details.
 
 use schemars::JsonSchema;
-use serde::{Deserialize, Serialize};
+use serde::{Deserialize, Serialize, de::Error as _};
 use serde_with::skip_serializing_none;
 use url::Url;
 
 use super::ConfigurationSection;
 
+fn sample_rate_example() -> f64 {
+    0.5
+}
+
 /// Propagation format for incoming and outgoing requests
 #[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
 #[serde(rename_all = "lowercase")]
@@ -116,13 +120,38 @@ fn sentry_dsn_example() -> &'static str {
     "https://public@host:port/1"
 }
 
+fn sentry_environment_example() -> &'static str {
+    "production"
+}
+
 /// Configuration related to the Sentry integration
 #[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
 pub struct SentryConfig {
     /// Sentry DSN
     #[schemars(url, example = "sentry_dsn_example")]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub dsn: Option<String>,
+
+    /// Environment to use when sending events to Sentry
+    ///
+    /// Defaults to `production` if not set.
+    #[schemars(example = "sentry_environment_example")]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub environment: Option<String>,
+
+    /// Sample rate for event submissions
+    ///
+    /// Defaults to `1.0` if not set.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[schemars(example = "sample_rate_example", range(min = 0.0, max = 1.0))]
+    pub sample_rate: Option<f32>,
+
+    /// Sample rate for tracing transactions
+    ///
+    /// Defaults to `0.0` if not set.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[schemars(example = "sample_rate_example", range(min = 0.0, max = 1.0))]
+    pub traces_sample_rate: Option<f32>,
 }
 
 impl SentryConfig {

docs/config.schema.json

@@ -1333,6 +1333,33 @@
           ],
           "type": "string",
           "format": "uri"
+        },
+        "environment": {
+          "description": "Environment to use when sending events to Sentry\n\nDefaults to `production` if not set.",
+          "examples": [
+            "production"
+          ],
+          "type": "string"
+        },
+        "sample_rate": {
+          "description": "Sample rate for event submissions\n\nDefaults to `1.0` if not set.",
+          "examples": [
+            0.5
+          ],
+          "type": "number",
+          "format": "float",
+          "maximum": 1.0,
+          "minimum": 0.0
+        },
+        "traces_sample_rate": {
+          "description": "Sample rate for tracing transactions\n\nDefaults to `0.0` if not set.",
+          "examples": [
+            0.5
+          ],
+          "type": "number",
+          "format": "float",
+          "maximum": 1.0,
+          "minimum": 0.0
         }
       }
     },