add changelog entries for feature and doc changes

pull/16738/head
zeeshanrafiqrana 2023-12-12 02:26:20 +05:00
parent da85445554
commit 0b7d3b2905
4 changed files with 5 additions and 6 deletions

1
changelog.d/16738.doc Normal file
View File

@ -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.

View File

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

View File

@ -2772,7 +2772,7 @@ enable_metrics: true
### `sentry` ### `sentry`
Use this option to enable sentry integration. Provide the DSN assigned to you by sentry Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
with the `dsn` setting. with the `dsn` setting and specify the environment in the `environment` field. 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 NOTE: While attempts are made to ensure that the logs don't contain
any sensitive information, this cannot be guaranteed. By enabling any sensitive information, this cannot be guaranteed. By enabling
@ -2783,6 +2783,7 @@ through insecure notification channels if so configured.
Example configuration: Example configuration:
```yaml ```yaml
sentry: sentry:
environment: "production"
dsn: "..." dsn: "..."
``` ```
--- ---

View File

@ -662,14 +662,10 @@ def setup_sentry(hs: "HomeServer") -> None:
import sentry_sdk import sentry_sdk
# Set a default environment if it's not configured
default_environment = None
environment = hs.config.metrics.sentry_environment or default_environment
sentry_sdk.init( sentry_sdk.init(
dsn=hs.config.metrics.sentry_dsn, dsn=hs.config.metrics.sentry_dsn,
release=SYNAPSE_VERSION, release=SYNAPSE_VERSION,
environment=environment, environment=hs.config.metrics.sentry_environment,
) )
# We set some default tags that give some context to this instance # We set some default tags that give some context to this instance