diff --git a/docs/configuration/error-reporting.md b/docs/configuration/error-reporting.md index 4423706d6..56f187845 100644 --- a/docs/configuration/error-reporting.md +++ b/docs/configuration/error-reporting.md @@ -31,6 +31,17 @@ The sampling rate for errors. Must be a value between 0 (disabled) and 1.0 (repo --- +## SENTRY_SEND_DEFAULT_PII + +Default: False + +Maps to the Sentry SDK's [`send_default_pii`](https://docs.sentry.io/platforms/python/configuration/options/#send-default-pii) parameter. If enabled, certain personally identifiable information (PII) is added. + +!!! warning "Sensitive data" + If you enable this option, be aware that sensitive data such as cookies and authentication tokens will be logged. + +--- + ## SENTRY_TAGS An optional dictionary of tag names and values to apply to Sentry error reports.For example: @@ -55,14 +66,3 @@ The sampling rate for transactions. Must be a value between 0 (disabled) and 1.0 !!! warning "Consider performance implications" A high sampling rate for transactions can induce significant performance penalties. If transaction reporting is desired, it is recommended to use a relatively low sample rate of 10% to 20% (0.1 to 0.2). - ---- - -## SENTRY_SEND_DEFAULT_PII - -Default: False (disabled) - -If this flag is enabled, certain personally identifiable information (PII) is added. - -!!! warning "Sensitive data" - If you enable this option, be aware that senstive data such as cookies and auth tokens will be logged. diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 2721fd046..151970cb7 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -147,9 +147,9 @@ SECURE_SSL_REDIRECT = getattr(configuration, 'SECURE_SSL_REDIRECT', False) SENTRY_DSN = getattr(configuration, 'SENTRY_DSN', None) SENTRY_ENABLED = getattr(configuration, 'SENTRY_ENABLED', False) SENTRY_SAMPLE_RATE = getattr(configuration, 'SENTRY_SAMPLE_RATE', 1.0) +SENTRY_SEND_DEFAULT_PII = getattr(configuration, 'SENTRY_SEND_DEFAULT_PII', False) SENTRY_TAGS = getattr(configuration, 'SENTRY_TAGS', {}) SENTRY_TRACES_SAMPLE_RATE = getattr(configuration, 'SENTRY_TRACES_SAMPLE_RATE', 0) -SENTRY_SEND_DEFAULT_PII = getattr(configuration, 'SENTRY_SEND_DEFAULT_PII', False) SESSION_COOKIE_NAME = getattr(configuration, 'SESSION_COOKIE_NAME', 'sessionid') SESSION_COOKIE_PATH = CSRF_COOKIE_PATH SESSION_COOKIE_SECURE = getattr(configuration, 'SESSION_COOKIE_SECURE', False)