Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
add changelog entries for feature and doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
zeeshanrafiqrana committed Dec 11, 2023
1 parent da85445 commit 0b7d3b2
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 6 deletions.
1 change: 1 addition & 0 deletions changelog.d/16738.doc
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions changelog.d/16738.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Enhanced Sentry configuration with a startup-loaded environment for improved system monitoring. Contributed by @zeeshanrafiqrana.
3 changes: 2 additions & 1 deletion docs/usage/configuration/config_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2772,7 +2772,7 @@ 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 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
any sensitive information, this cannot be guaranteed. By enabling
Expand All @@ -2783,6 +2783,7 @@ through insecure notification channels if so configured.
Example configuration:
```yaml
sentry:
environment: "production"
dsn: "..."
```
---
Expand Down
6 changes: 1 addition & 5 deletions synapse/app/_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -662,14 +662,10 @@ def setup_sentry(hs: "HomeServer") -> None:

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(
dsn=hs.config.metrics.sentry_dsn,
release=SYNAPSE_VERSION,
environment=environment,
environment=hs.config.metrics.sentry_environment,
)

# We set some default tags that give some context to this instance
Expand Down

0 comments on commit 0b7d3b2

Please sign in to comment.