Page MenuHomeSoftware Heritage
Files F9314023

sentry.py
No OneTemporary
Actions

sentry.py
View Options

# Copyright (C) 2019-2020 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
import logging
import os
from typing import Dict, List, Optional
import pkg_resources
logger = logging.getLogger(__name__)
def get_sentry_release():
main_package = os.environ.get("SWH_MAIN_PACKAGE")
if main_package:
version = pkg_resources.get_distribution(main_package).version
return f"{main_package}@{version}"
else:
return None
def override_with_bool_envvar(envvar: str, default: bool) -> bool:
"""Override the `default` with the environment variable `envvar` parsed as a boolean"""
envvalue = os.environ.get(envvar, "")
if envvalue.lower() in ("t", "true", "y", "yes", "1"):
return True
elif envvalue.lower() in ("f", "false", "n", "no", "0"):
return False
else:
if envvalue:
logger.warning(
"Could not interpret environment variable %s=%r as boolean, "
"using default value %s",
envvar,
envvalue,
default,
)
return default
def init_sentry(
sentry_dsn: Optional[str] = None,
*,
environment: Optional[str] = None,
debug: bool = False,
disable_logging_events: bool = False,
integrations: Optional[List] = None,
extra_kwargs: Optional[Dict] = None,
):
"""Configure the sentry integration
Args:
sentry_dsn: Sentry DSN; where sentry report will be sent. Overridden by
:envvar:`SWH_SENTRY_DSN`
environment: Sentry environment. Overridden by :envvar:`SWH_SENTRY_ENVIRONMENT`
debug: turn on Sentry SDK debug mode. Overridden by :envvar:`SWH_SENTRY_DEBUG`
disable_logging_events: if set, disable the automatic reporting of error/exception
log entries as Sentry events. Overridden by
:envvar:`SWH_SENTRY_DISABLE_LOGGING_EVENTS`
integrations: list of dedicated Sentry integrations to include
extra_kwargs: dict of additional parameters passed to :func:`sentry_sdk.init`
"""
if integrations is None:
integrations = []
if extra_kwargs is None:
extra_kwargs = {}
sentry_dsn = os.environ.get("SWH_SENTRY_DSN", sentry_dsn)
environment = os.environ.get("SWH_SENTRY_ENVIRONMENT", environment)
debug = override_with_bool_envvar("SWH_SENTRY_DEBUG", debug)
disable_logging_events = override_with_bool_envvar(
"SWH_SENTRY_DISABLE_LOGGING_EVENTS", disable_logging_events
)
if sentry_dsn:
import sentry_sdk
if disable_logging_events:
from sentry_sdk.integrations.logging import LoggingIntegration
integrations.append(LoggingIntegration(event_level=None))
sentry_sdk.init(
release=get_sentry_release(),
environment=environment,
dsn=sentry_dsn,
integrations=integrations,
debug=debug,
**extra_kwargs,
)

File Metadata

Mime Type
text/x-python
Expires
Thu, Jul 3, 12:07 PM (1 d, 9 h ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3239132

Event Timeline

About · Developer information · Legal