Merge pull request #106 from maykinmedia/issue/88-sentry-config

🐛 [#88] remove function to init Sentry

Author: stevenbal

docs/quickstart.rst

@@ -28,12 +28,6 @@ Add the following imports to the top of the project's ``base.py`` file:
     from open_api_framework.conf.base import *  # noqa
     from open_api_framework.conf.utils import config
 
-Then you can initialize sentry by adding the following line to ``base.py``:
-
-.. code:: python
-
-    init_sentry()
-
 
 After that, compare the settings from `open_api_framework.conf.base`_ to the settings
 defined in the project's ``base.py`` and remove settings from the latter to make use of the generic settings (if this is desired).

open_api_framework/conf/base.py

@@ -2,7 +2,6 @@
 import os
 import warnings
 from pathlib import Path
-from typing import Callable
 
 from django.urls import reverse_lazy
 
@@ -809,35 +808,40 @@
 #
 # SENTRY - error monitoring
 #
+SENTRY_DSN = config(
+    "SENTRY_DSN",
+    None,
+    help_text=(
+        "URL of the sentry project to send error reports to. Default empty, "
+        "i.e. -> no monitoring set up. Highly recommended to configure this."
+    ),
+    auto_display_default=False,
+)
 
+SENTRY_BEFORE_SEND = config(
+    "SENTRY_BEFORE_SEND",
+    None,
+    help_text=(
+        "Callback, which allows projects to define their own before_send filters"
+    ),
+    auto_display_default=False,
+)
 
-def init_sentry(before_send: Callable | None = None):
-    SENTRY_DSN = config(
-        "SENTRY_DSN",
-        None,
-        help_text=(
-            "URL of the sentry project to send error reports to. Default empty, "
-            "i.e. -> no monitoring set up. Highly recommended to configure this."
-        ),
-        auto_display_default=False,
-    )
+if SENTRY_DSN:
+    SENTRY_CONFIG = {
+        "dsn": SENTRY_DSN,
+        "release": RELEASE or "RELEASE not set",
+        "environment": ENVIRONMENT,
+    }
 
-    if SENTRY_DSN:
-        SENTRY_CONFIG = {
-            "dsn": SENTRY_DSN,
-            "release": RELEASE or "RELEASE not set",
-            "environment": ENVIRONMENT,
-        }
-
-        # Allow projects to define their own before_send filters
-        if before_send:
-            SENTRY_CONFIG["before_send"] = before_send
-
-        sentry_sdk.init(
-            **SENTRY_CONFIG,
-            integrations=get_sentry_integrations(),
-            send_default_pii=True,
-        )
+    if SENTRY_BEFORE_SEND:
+        SENTRY_CONFIG["before_send"] = SENTRY_BEFORE_SEND
+
+    sentry_sdk.init(
+        **SENTRY_CONFIG,
+        integrations=get_sentry_integrations(),
+        send_default_pii=True,
+    )
 
 
 #

pyproject.toml

@@ -68,6 +68,7 @@ Documentation = "http://open_api_framework.readthedocs.io/en/latest/"
 tests = [
     "pytest",
     "pytest-django",
+    "pytest-env",
     "tox",
     "isort",
     "black",
@@ -99,7 +100,12 @@ sections=["FUTURE", "STDLIB", "DJANGO", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-DJANGO_SETTINGS_MODULE = "testapp.settings"
+pythonpath = "."
+env = [
+    "DJANGO_SETTINGS_MODULE=testapp.settings",
+    "SECRET_KEY=not-so-secret",
+    "SENTRY_DSN=https://[email protected]/1"
+]
 
 [tool.bumpversion]
 current_version = "0.9.2"

setup.cfg

@@ -2,4 +2,4 @@
 
 [flake8]
 max-line-length = 119
-exclude=env,.tox,doc
+exclude=env,.tox,doc,tests/test_generate_envvar_docs.py

testapp/settings.py

@@ -1,5 +1,6 @@
 from pathlib import Path
 
+from open_api_framework.conf.base import SENTRY_CONFIG, SENTRY_DSN  # noqa
 from open_api_framework.conf.utils import config
 
 BASE_DIR = Path(__file__).resolve(strict=True).parent

tests/test_generate_envvar_docs.py

@@ -18,17 +18,92 @@
 Required
 --------
 
-* ``SECRET_KEY``: Secret key that's used for certain cryptographic utilities. Defaults to: \
-``so-secret-i-cant-believe-you-are-looking-at-this``.
+* ``SECRET_KEY``: Secret key that's used for certain cryptographic utilities. Defaults to: ``so-secret-i-cant-believe-you-are-looking-at-this``.
+* ``ALLOWED_HOSTS``: a comma separated (without spaces!) list of domains that serve the installation. Used to protect against Host header attacks. Defaults to: ``(empty string)``.
+* ``CACHE_DEFAULT``: redis cache address for the default cache (this **MUST** be set when using Docker). Defaults to: ``localhost:6379/0``.
+* ``CACHE_AXES``: redis cache address for the brute force login protection cache (this **MUST** be set when using Docker). Defaults to: ``localhost:6379/0``.
+* ``EMAIL_HOST``: hostname for the outgoing e-mail server (this **MUST** be set when using Docker). Defaults to: ``localhost``.
+
+
+Database
+--------
+
+* ``DB_NAME``: name of the PostgreSQL database. Defaults to: ``testapp``.
+* ``DB_USER``: username of the database user. Defaults to: ``testapp``.
+* ``DB_PASSWORD``: password of the database user. Defaults to: ``testapp``.
+* ``DB_HOST``: hostname of the PostgreSQL database. Defaults to ``db`` for the docker environment, otherwise defaults to ``localhost``.
+* ``DB_PORT``: port number of the database. Defaults to: ``5432``.
+
+
+Cross-Origin-Resource-Sharing
+-----------------------------
+
+* ``CORS_ALLOW_ALL_ORIGINS``: allow cross-domain access from any client. Defaults to: ``False``.
+* ``CORS_ALLOWED_ORIGINS``: explicitly list the allowed origins for cross-domain requests. Example: http://localhost:3000,https://some-app.gemeente.nl. Defaults to: ``[]``.
+* ``CORS_ALLOWED_ORIGIN_REGEXES``: same as ``CORS_ALLOWED_ORIGINS``, but supports regular expressions. Defaults to: ``[]``.
+* ``CORS_EXTRA_ALLOW_HEADERS``: headers that are allowed to be sent as part of the cross-domain request. By default, Authorization, Accept-Crs and Content-Crs are already included. The value of this variable is added to these already included headers. Defaults to: ``[]``.
+
+
+Celery
+------
+
+* ``CELERY_RESULT_BACKEND``: the URL of the backend/broker that will be used by Celery to send the notifications. Defaults to: ``redis://localhost:6379/1``.
+
+
+Elastic APM
+-----------
+
+* ``ELASTIC_APM_SERVER_URL``: URL where Elastic APM is hosted. Defaults to: ``None``.
+* ``ELASTIC_APM_SERVICE_NAME``: Name of the service for this application in Elastic APM. Defaults to ``testapp - <environment>``.
+* ``ELASTIC_APM_SECRET_TOKEN``: Token used to communicate with Elastic APM. Defaults to: ``default``.
+* ``ELASTIC_APM_TRANSACTION_SAMPLE_RATE``: By default, the agent will sample every transaction (e.g. request to your service). To reduce overhead and storage requirements, set the sample rate to a value between 0.0 and 1.0. Defaults to: ``0.1``.
+
+
+Content Security Policy
+-----------------------
+
+* ``CSP_EXTRA_DEFAULT_SRC``: Extra default source URLs for CSP other than ``self``. Used for ``img-src``, ``style-src`` and ``script-src``. Defaults to: ``[]``.
+* ``CSP_REPORT_URI``: URI of the``report-uri`` directive. Defaults to: ``None``.
+* ``CSP_REPORT_PERCENTAGE``: Percentage of requests that get the ``report-uri`` directive. Defaults to: ``0``.
+* ``CSP_EXTRA_FORM_ACTION``: Add additional ``form-action`` source to the default . Defaults to: ``[]``.
+* ``CSP_FORM_ACTION``: Override the default ``form-action`` source. Defaults to: ``['"\\'self\\'"']``.
+* ``CSP_EXTRA_IMG_SRC``: Extra ``img-src`` sources for CSP other than ``CSP_DEFAULT_SRC``. Defaults to: ``[]``.
+* ``CSP_OBJECT_SRC``: ``object-src`` urls. Defaults to: ``['"\\'none\\'"']``.
 
 
 Optional
 --------
 
-* ``DEBUG``: Only set this to ``True`` on a local development environment. Various other \
-security settings are derived from this setting!. Defaults to: ``False``.
-* ``IS_HTTPS``: Used to construct absolute URLs and controls a variety of security settings. \
-Defaults to the inverse of ``DEBUG``.
+* ``SITE_ID``: The database ID of the site object. You usually won't have to touch this. Defaults to: ``1``.
+* ``DEBUG``: Only set this to ``True`` on a local development environment. Various other security settings are derived from this setting!. Defaults to: ``False``.
+* ``USE_X_FORWARDED_HOST``: whether to grab the domain/host from the X-Forwarded-Host header or not. This header is typically set by reverse proxies (such as nginx, traefik, Apache...). Note: this is a header that can be spoofed and you need to ensure you control it before enabling this. Defaults to: ``False``.
+* ``IS_HTTPS``: Used to construct absolute URLs and controls a variety of security settings. Defaults to the inverse of ``DEBUG``.
+* ``EMAIL_PORT``: port number of the outgoing e-mail server. Note that if you're on Google Cloud, sending e-mail via port 25 is completely blocked and you should use 487 for TLS. Defaults to: ``25``.
+* ``EMAIL_HOST_USER``: username to connect to the mail server. Defaults to: ``(empty string)``.
+* ``EMAIL_HOST_PASSWORD``: password to connect to the mail server. Defaults to: ``(empty string)``.
+* ``EMAIL_USE_TLS``: whether to use TLS or not to connect to the mail server. Should be True if you're changing the ``EMAIL_PORT`` to 487. Defaults to: ``False``.
+* ``DEFAULT_FROM_EMAIL``: The default email address from which emails are sent. Defaults to: ``[email protected]``.
+* ``LOG_STDOUT``: whether to log to stdout or not. Defaults to: ``True``.
+* ``LOG_LEVEL``: control the verbosity of logging output. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``WARNING``.
+* ``LOG_QUERIES``: enable (query) logging at the database backend level. Note that you must also set ``DEBUG=1``, which should be done very sparingly!. Defaults to: ``False``.
+* ``LOG_REQUESTS``: enable logging of the outgoing requests. Defaults to: ``False``.
+* ``CELERY_LOGLEVEL``: control the verbosity of logging output for celery, independent of ``LOG_LEVEL``. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``INFO``.
+* ``SESSION_COOKIE_AGE``: For how long, in seconds, the session cookie will be valid. Defaults to: ``1209600``.
+* ``SESSION_COOKIE_SAMESITE``: The value of the SameSite flag on the session cookie. This flag prevents the cookie from being sent in cross-site requests thus preventing CSRF attacks and making some methods of stealing session cookie impossible.Currently interferes with OIDC. Keep the value set at Lax if used. Defaults to: ``Lax``.
+* ``CSRF_COOKIE_SAMESITE``: The value of the SameSite flag on the CSRF cookie. This flag prevents the cookie from being sent in cross-site requests. Defaults to: ``Strict``.
+* ``ENVIRONMENT``: An identifier for the environment, displayed in the admin depending on the settings module used and included in the error monitoring (see ``SENTRY_DSN``). The default is set according to ``DJANGO_SETTINGS_MODULE``.
+* ``SUBPATH``: If hosted on a subpath, provide the value here. If you provide ``/gateway``, the component assumes its running at the base URL: ``https://somedomain/gateway/``. Defaults to an empty string. Defaults to: ``None``.
+* ``RELEASE``: The version number or commit hash of the application (this is also sent to Sentry).
+* ``NUM_PROXIES``: the number of reverse proxies in front of the application, as an integer. This is used to determine the actual client IP adres. On Kubernetes with an ingress you typically want to set this to 2. Defaults to: ``1``.
+* ``CSRF_TRUSTED_ORIGINS``: A list of trusted origins for unsafe requests (e.g. POST). Defaults to: ``[]``.
+* ``NOTIFICATIONS_DISABLED``: indicates whether or not notifications should be sent to the Notificaties API for operations on the API endpoints. Defaults to ``True`` for the ``dev`` environment, otherwise defaults to ``False``.
+* ``SENTRY_DSN``: URL of the sentry project to send error reports to. Default empty, i.e. -> no monitoring set up. Highly recommended to configure this.
+* ``SENTRY_BEFORE_SEND``: Callback, which allows projects to define their own before_send filters.
+* ``DISABLE_2FA``: Whether or not two factor authentication should be disabled. Defaults to: ``False``.
+* ``LOG_OUTGOING_REQUESTS_EMIT_BODY``: Whether or not outgoing request bodies should be logged. Defaults to: ``True``.
+* ``LOG_OUTGOING_REQUESTS_DB_SAVE``: Whether or not outgoing request logs should be saved to the database. Defaults to: ``False``.
+* ``LOG_OUTGOING_REQUESTS_DB_SAVE_BODY``: Whether or not outgoing request bodies should be saved to the database. Defaults to: ``True``.
+* ``LOG_OUTGOING_REQUESTS_MAX_AGE``: The amount of time after which request logs should be deleted from the database. Defaults to: ``7``.
 
 
 

tests/test_settings.py

@@ -0,0 +1,8 @@
+def test_sentry_settings():
+    """
+    test that sentry settings are initialized
+    """
+    from django.conf import settings
+
+    assert hasattr(settings, "SENTRY_CONFIG") is True
+    assert hasattr(settings, "SENTRY_DSN") is True