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.0.post1.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.

File details

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

File metadata

File hashes

Hashes for instruktai_python_logger-0.1.0.post1.tar.gz
Algorithm Hash digest
SHA256 c823638d24c5920b08e635c73f155fc4b422005e09df0b94cbdd21872e7f130c
MD5 0318d06c11ee38499e49714c0b02104d
BLAKE2b-256 d09d1f91d77c983567d4ae472e9000157275c7439480aa758c5873709ae42672

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for instruktai_python_logger-0.1.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 76fafde0ae8c52c94f1e85dd62935af339eb0bb857cce93f091b1fca0199f82d
MD5 2f5ccf05e71b8692e3f3b71aae3c04c0
BLAKE2b-256 375a7703691de22a036b47b5fdca655c3e61b3352898e3a8b72c671eb8e67bf2

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