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.

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.9.28.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

thoth_common-0.9.28-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: thoth-common-0.9.28.tar.gz
  • Upload date:
  • Size: 25.8 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.9.28.tar.gz
Algorithm Hash digest
SHA256 120de30be4bebe890fbca56c4ff11765296f25ed92c738aaf8707d53f4afc364
MD5 b6dce7b7828859c4554197c4a87a6dae
BLAKE2b-256 1e7228b2278d6d53a4d7c01fe1935587a88f7354cf15b9aeaa8eb40319871c8f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: thoth_common-0.9.28-py3-none-any.whl
  • Upload date:
  • Size: 35.3 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.9.28-py3-none-any.whl
Algorithm Hash digest
SHA256 fb324c6ec5ac0ddcd8c367eb25e8e8d8c425c7b8825e4df4f2ce5849a7e3e168
MD5 2f3bd283fde449dc3d85cb51531e70bd
BLAKE2b-256 1adbf0fa935875867161736d6b3f4cacd993538222a846ab04e8313ad61383d7

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