Allow customizing server_name and release tags with corresponding fields in Sentry config (#413)

Author: droserasprout

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [Unreleased]
+
+### Added
+
+* sentry: Allow customizing `server_name` and `release` tags with corresponding fields in Sentry config.
+
 ## [5.2.2] - 2022-07-03
 
 ### Fixed

docs/config/reference.md

@@ -474,13 +474,15 @@ http: HTTP client configuration</p>
 
 <dl class="py class">
 <dt class="sig sig-object py" id="dipdup.config.SentryConfig">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dipdup.config.</span></span><span class="sig-name descname"><span class="pre">SentryConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dsn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">environment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dipdup.config.SentryConfig" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dipdup.config.</span></span><span class="sig-name descname"><span class="pre">SentryConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dsn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">environment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dipdup.config.SentryConfig" title="Permalink to this definition">¶</a></dt>
 <dd><p>Config for Sentry integration.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>dsn</strong> – DSN of the Sentry instance</p></li>
-<li><p><strong>environment</strong> – Environment to report to Sentry (informational only)</p></li>
+<li><p><strong>environment</strong> – Environment (defaults to <cite>production</cite>)</p></li>
+<li><p><strong>server_name</strong> – Server name (defaults to hostname)</p></li>
+<li><p><strong>release</strong> – Release version (defaults to DipDup version)</p></li>
 <li><p><strong>debug</strong> – Catch warning messages and more context</p></li>
 </ul>
 </dd>

src/dipdup/cli.py

@@ -133,11 +133,14 @@ def _init_sentry(config: DipDupConfig) -> None:
     sentry_sdk.init(
         dsn=config.sentry.dsn,
         environment=config.sentry.environment,
+        server_name=config.sentry.server_name,
+        release=config.sentry.release or __version__,
         integrations=integrations,
-        release=__version__,
         attach_stacktrace=attach_stacktrace,
         before_send=_sentry_before_send,
     )
+    sentry_sdk.set_tag('dipdup_version', __version__)
+    sentry_sdk.set_tag('dipdup_package', config.package)
 
 
 async def _check_version() -> None:

src/dipdup/config.py

@@ -1076,12 +1076,16 @@ class SentryConfig:
     """Config for Sentry integration.
 
     :param dsn: DSN of the Sentry instance
-    :param environment: Environment to report to Sentry (informational only)
+    :param environment: Environment (defaults to `production`)
+    :param server_name: Server name (defaults to hostname)
+    :param release: Release version (defaults to DipDup version)
     :param debug: Catch warning messages and more context
     """
 
     dsn: str
     environment: Optional[str] = None
+    server_name: Optional[str] = None
+    release: Optional[str] = None
     debug: bool = False