Skip to main content

RSE standard logging with correlation id, Vault-backed Telegram alerts, and FastAPI middleware.

Project description

rse-logging

RSE standard logging package for Python APIs.

Features:

  • colored console logs
  • request correlation id with ContextVar
  • FastAPI middleware for X-Correlation-ID
  • helper functions: log_info, log_warning, log_error
  • Telegram alerts for ERROR logs in stg and prd
  • Telegram credentials loaded from HashiCorp Vault

Usage

from fastapi import FastAPI
from rse_logging import CorrelationIdMiddleware, log_error, setup_logger

setup_logger("my-api")

app = FastAPI()
app.add_middleware(CorrelationIdMiddleware)

log_error("startup", "Example error")

Diagnostics

To debug Telegram/Vault configuration without printing tokens:

from rse_logging import diagnose_telegram, setup_logger

setup_logger("my-api")
print(diagnose_telegram(send_test_message=True))

Set RSE_LOGGING_DEBUG=true to print skipped Telegram alert reasons to stderr.

Vault

Telegram alerts are enabled only when RSE_ENV is stg or prd.

The package reads Vault using:

  • RSE_ENV as the KV v2 mount point
  • RSE_VAULT_HOST as the Vault URL
  • RSE_VAULT_TOKEN as the Vault token
  • shared as the default secret path

Expected keys:

telegram_bot_token
telegram_chat_id

Examples:

stg/shared.telegram_bot_token
stg/shared.telegram_chat_id
prd/shared.telegram_bot_token
prd/shared.telegram_chat_id

Set RSE_LOGGING_TELEGRAM_ENABLED=false to disable Telegram alerts.

Project details


Download files

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

Source Distribution

rse_logging-0.1.3.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rse_logging-0.1.3-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file rse_logging-0.1.3.tar.gz.

File metadata

  • Download URL: rse_logging-0.1.3.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.0 Windows/10

File hashes

Hashes for rse_logging-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e76bfa306876446bca742937ac620dbb18164c97e6c542208b1e517fec229e66
MD5 932b10f66ab94c4893a8702d66d6862c
BLAKE2b-256 e11d771726069edba1eeae1cab2395f633a4dd8255d3de31e86624652fd81917

See more details on using hashes here.

File details

Details for the file rse_logging-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: rse_logging-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.0 Windows/10

File hashes

Hashes for rse_logging-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 29e79c7167fa5ebc2d540ca8abe508d75d34ecf030237509c1f02685a1a4a9a6
MD5 920a9ae07abd6a94ce407e20564cd499
BLAKE2b-256 553889e741122e7ec5d306dfc0681fdff4f3e4b06ad7d729c96ba71af541abda

See more details on using hashes here.

Supported by

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