Sentry Alert configuration based on production and development environment

changelog.d/16738.doc

@@ -0,0 +1 @@
+Clarify that in the Sentry configuration, adding the sentry.environment setting alongside the existing sentry.dsn setting enables log maintenance based on different environments, enhancing organizational control and analysis.

changelog.d/16738.feature

@@ -0,0 +1 @@
+Enhanced Sentry configuration with a startup-loaded environment for improved system monitoring. Contributed by @zeeshanrafiqrana.

docs/usage/configuration/config_documentation.md

@@ -2772,7 +2772,11 @@ enable_metrics: true
 ### `sentry`
 
 Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
-with the `dsn` setting.
+with the `dsn` setting. 
+
+ An optional `environment` field can be used to specify an environment. This allows
+ for log maintenance based on different environments, ensuring better organization
+ and analysis..
 
 NOTE: While attempts are made to ensure that the logs don't contain
 any sensitive information, this cannot be guaranteed. By enabling
@@ -2783,6 +2787,7 @@ through insecure notification channels if so configured.
 Example configuration:
 ```yaml
 sentry:
+    environment: "production"
     dsn: "..."
 ```
 ---

synapse/app/_base.py

@@ -665,6 +665,7 @@ def setup_sentry(hs: "HomeServer") -> None:
     sentry_sdk.init(
         dsn=hs.config.metrics.sentry_dsn,
         release=SYNAPSE_VERSION,
+        environment=hs.config.metrics.sentry_environment,
     )
 
     # We set some default tags that give some context to this instance

synapse/config/metrics.py

@@ -61,6 +61,7 @@ def read_config(self, config: JsonDict, **kwargs: Any) -> None:
             check_requirements("sentry")
 
             self.sentry_dsn = config["sentry"].get("dsn")
+            self.sentry_environment = config["sentry"].get("environment")
             if not self.sentry_dsn:
                 raise ConfigError(
                     "sentry.dsn field is required when sentry integration is enabled"