def configure_error_reporting(self, client: "raven.Client") -> None:
"""Send reports for unexpected exceptions to the given client.
This also adds a :py:class:`raven.Client` object to the ``sentry``
attribute on the :py:class:`~baseplate.RequestContext` where you can
send your own application-specific events.
.. deprecated:: 1.0
Use :py:meth:`configure_observers` instead.
:param client: A configured raven client.
"""
# pylint: disable=cyclic-import
from baseplate.observers.sentry import SentryBaseplateObserver, SentryUnhandledErrorReporter
from gevent import get_hub
hub = get_hub()
hub.print_exception = SentryUnhandledErrorReporter(hub, client)
self.register(SentryBaseplateObserver(client))
def baseplate_app():
baseplate = Baseplate()
baseplate.register(SentryBaseplateObserver())
return baseplate
def configure_observers(self) -> None:
"""Configure diagnostics observers based on application configuration.
This installs all the currently supported observers that have settings
in the configuration file.
See :py:mod:`baseplate.observers` for the configuration settings
available for each observer.
"""
skipped = []
from baseplate.observers.logging import LoggingBaseplateObserver
self.register(LoggingBaseplateObserver())
if gevent.monkey.is_module_patched("socket"):
from baseplate.observers.timeout import TimeoutBaseplateObserver
timeout_observer = TimeoutBaseplateObserver.from_config(
self._app_config)
self.register(timeout_observer)
else:
skipped.append("timeout")
if "metrics.tagging" in self._app_config:
if "metrics.namespace" in self._app_config:
raise ValueError(
"metrics.namespace not allowed with metrics.tagging")
from baseplate.lib.metrics import metrics_client_from_config
from baseplate.observers.metrics_tagged import TaggedMetricsBaseplateObserver
self._metrics_client = metrics_client_from_config(self._app_config)
self.register(
TaggedMetricsBaseplateObserver.from_config_and_client(
self._app_config, self._metrics_client))
elif "metrics.namespace" in self._app_config:
from baseplate.lib.metrics import metrics_client_from_config
from baseplate.observers.metrics import MetricsBaseplateObserver
self._metrics_client = metrics_client_from_config(self._app_config)
self.register(
MetricsBaseplateObserver.from_config_and_client(
self._app_config, self._metrics_client))
else:
skipped.append("metrics")
if "tracing.service_name" in self._app_config:
from baseplate.observers.tracing import tracing_client_from_config
from baseplate.observers.tracing import TraceBaseplateObserver
tracing_client = tracing_client_from_config(self._app_config)
self.register(TraceBaseplateObserver(tracing_client))
else:
skipped.append("tracing")
if "sentry.dsn" in self._app_config or "SENTRY_DSN" in os.environ:
from baseplate.observers.sentry import init_sentry_client_from_config
from baseplate.observers.sentry import SentryBaseplateObserver
from baseplate.observers.sentry import _SentryUnhandledErrorReporter
init_sentry_client_from_config(self._app_config)
_SentryUnhandledErrorReporter.install()
self.register(SentryBaseplateObserver())
else:
skipped.append("sentry")
if skipped:
logger.debug(
"The following observers are unconfigured and won't run: %s",
", ".join(skipped))