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(...)
  • Logger helper: instrukt_ai_logging.get_logger(name) (named **kv logging)
  • CLI entrypoint: instrukt-ai-logs (reads recent log lines)

Example:

import logging
from instrukt_ai_logging import configure_logging

configure_logging("teleclaude")
logger = logging.getLogger("teleclaude.core")
logger.info("job_started", job_id="abc123", user_id=123)

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.4.tar.gz (8.4 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.4-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for instruktai_python_logger-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9da08cdd89919252e2d289b29672764a6e246f17dcefaae4ddfcfdc68e41e34c
MD5 0168082b772f761a046a638150e1d45e
BLAKE2b-256 14fa62136f64cf653a80626d67b38e3eee9dc9c2e856d140134253a2ed37ed65

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for instruktai_python_logger-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e4a93283215e6b307db1ee4c3afb9eb453675462c0fdd0e16b4a44216211d354
MD5 16bb1a296b34347d4b9fe0160e60d514
BLAKE2b-256 927d1bc29a6f2823c8afa72656eb2c32d028d8a5bd2a1ad0a3a7841816a772b3

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