Skip to main content

Shared code logic in the project Thoth.

Project description

A library used in project Thoth. It’s aim is to provide core utilities for logger setup, manipulation with datetimes and similar handy helpers.

Installation

This project is released on PyPI, so the latest release can be installed via pip or Pipenv as shown below:

pipenv install thoth-common

This library will automatically discover installed packages and enable Sentry integrations if you use Flask, SQLAlchemy or AIOHTTP. An exception is for Flask applications, that need to explicitly install sentry-sdk[flask] due to integrations dependencies.

Logging setup

To setup a logger in any of Thoth’s component (component that are namespaced with thoth), you can simply set an environment variable. The name of environment variable is constructed from module name. Let’s say you want to debug thoth.adviser.pipeline module, in that case you can set environment variable:

THOTH_LOG_ADVISER_PIPELINE=DEBUG which will cause loggers thoth.adviser.pipeline to be set to DEBUG mode. See log-levels documentation for more info. If a module has underscore in its name, replace it with double underscore in the environment variable name.

To setup a logger that is not introduced by a Thoth’s component, you can set THOTH_ADJUST_LOGGING environment variable. The format of this environment variable THOTH_ADJUST_LOGGING is a comma separated list where each entry is made out of a logger name and a corresponding log-level (“DEBUG”, “INFO”, “WARNING”, “ERROR” as for standard Python’s logging). These two are delimited by a colon, an example:

THOTH_ADJUST_LOGGING="flask:WARNING,alembic.migrations:ERROR"

Ignoring reports from a logger

In some cases it’s expected to turn off reporting of some logger to Sentry. You can provide THOTH_SENTRY_IGNORE_LOGGER environment variable which holds a comma separated list of loggers that should be ignored when reporting errors to Sentry:

THOTH_SENTRY_IGNORE_LOGGER="thoth.adviser.resolver,thoth.adviser.run"

This is helpful if you want to report errors to users but not to Thoth application itself.

If you want some certain classes of error not to be reported to Sentry, you can can provide THOTH_SENTRY_IGNORE_EXCEPTION environment variable which holds the comma-separated list of exception classes to be ignored when reporting to Sentry:

THOTH_SENTRY_IGNORE_EXCEPTION="connexion.decorators.validation,builtins.ValueError"

Remember all builtin exception classes need to be specified as in the same manner as ValueError is specified above.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

thoth-common-0.10.0.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

thoth_common-0.10.0-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file thoth-common-0.10.0.tar.gz.

File metadata

  • Download URL: thoth-common-0.10.0.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/36.5.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.3

File hashes

Hashes for thoth-common-0.10.0.tar.gz
Algorithm Hash digest
SHA256 aaedee40bc17e041f0e95d936b8d12608dd7f1b62e00889889f71d7e62ad06fc
MD5 59523ec1a9b3e78ac31cb2696cecbffa
BLAKE2b-256 1d2bdd0b0bd1c2393510112b39c411711501157f47206c8f9819b07a49e82148

See more details on using hashes here.

File details

Details for the file thoth_common-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: thoth_common-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/36.5.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.3

File hashes

Hashes for thoth_common-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5932f17818d94f78d32ff19004a1f2b32810f9b15bb1d737f1fee77aae0b2fdd
MD5 a81470bdb0469e19c95eb66cbd30126a
BLAKE2b-256 a68a7d76e517e50032863850cd5f68935bf8116dff74851aea354377e642ccc9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page