Skip to main content

Centralized logging utilities for InstruktAI Python services.

Project description

instruktai-python-logger

Centralized logging utilities for InstruktAI Python services.

This repo provides a shared, consistent logging contract (env vars + output format + log location) intended to keep logs highly queryable (including by AIs that only read a tail window).

Background and rationale live in docs/design.md. Publishing notes live in docs/publishing.md.

Install (editable, local workspace)

From PyPI (recommended):

pip install instruktai-python-logger

From GitHub:

pip install git+ssh://git@github.com/InstruktAI/python-logger.git

API

  • Python entrypoint: instrukt_ai_logging.configure_logging(...)
  • Structured logging helper: instrukt_ai_logging.log_kv(logger, level, {"msg": "...", ...})
  • CLI entrypoint: instrukt-ai-logs (reads recent log lines)

Environment variables (contract)

Per-app prefix model (example uses TELECLAUDE_):

  • TELECLAUDE_LOG_LEVEL
  • TELECLAUDE_THIRD_PARTY_LOG_LEVEL
  • TELECLAUDE_THIRD_PARTY_LOGGERS (comma-separated logger prefixes, e.g. httpcore,telegram)

Global:

  • INSTRUKT_AI_LOG_ROOT (optional log root override)

Log location (contract)

Default target:

  • /var/log/instrukt-ai/{app}/{app}.log

The installer for each service is expected to create the directory and set write permissions for the daemon user. If the default location is not writable, the implementation will fall back to a user-writable directory and/or require INSTRUKT_AI_LOG_ROOT.

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

instruktai_python_logger-0.1.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

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

instruktai_python_logger-0.1.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file instruktai_python_logger-0.1.0.tar.gz.

File metadata

File hashes

Hashes for instruktai_python_logger-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e4535a8253fba51d078a9c088abafeb84735180e3d5c2f3b2bb6fc0bdbc12000
MD5 e71a0e8802689669768141b25063a69e
BLAKE2b-256 2c3fe7bdcb6e6d14c007902c106675b4694aa6631b919e48ee6378335a84dd11

See more details on using hashes here.

File details

Details for the file instruktai_python_logger-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for instruktai_python_logger-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 458db79f71603569d32475812d438b40374eacc67b7c242b0c5fd457ea96cbfb
MD5 cd3188bd5b2ce903f3029f86e1a0e4cc
BLAKE2b-256 6fd3e1b2f8b82e9c435c001dde4b699e8c8c18e54f1392c98cc70ceea60da720

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