Skip to main content

OpenTelemetry observability SDK for Python — structured logging, distributed tracing, and auto-instrumentation

Project description

otel-log

OpenTelemetry-compliant structured logging for Python. Produces JSON logs conforming to the OTel Log Data Model and optionally configures distributed tracing from a single call.

Installation

# Logging only (lightweight — only opentelemetry-api required)
pip install otel-log

# Logging + tracing
pip install otel-log[tracing]

Quick Start

import otel_log

result = otel_log.setup("my-service", version="1.0.0")

import logging
logging.info("Hello world")
# => {"Timestamp":"...","SeverityText":"INFO","SeverityNumber":9,"Body":"Hello world","Resource":{"service.name":"my-service","service.version":"1.0.0"}}

result.shutdown()

With Tracing

import otel_log

result = otel_log.setup("my-service", endpoint="localhost:4317")

with result.tracer.start_as_current_span("my-operation"):
    logging.info("Inside a span")
    # TraceId, SpanId, TraceFlags auto-injected into the JSON output

Advanced Usage

For auto-instrumentors, custom exporters, or fine-grained configuration:

from otel_log import OTelInitializer, ResourceConfig, InstrumentationConfig

result = OTelInitializer.initialize(
    resource_config=ResourceConfig(
        service_name="my-service",
        service_version="1.0.0",
        deployment_environment="production",
        custom_attributes={"cloud.region": "us-east-1"},
    ),
    instrumentation_config=InstrumentationConfig(
        endpoint="localhost:4317",
        protocol="grpc",
    ),
)

Environment Variables

Variable Required Description
OTEL_SERVICE_NAME Yes Service name (overrides config)
OTEL_EXPORTER_OTLP_ENDPOINT No OTLP trace exporter endpoint. If unset, tracing is disabled (no-op).
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT No OTLP log exporter endpoint. If unset, logs go to console only.
OTEL_RESOURCE_ATTRIBUTES No Comma-separated key=value resource attributes

Output Format

All logs conform to the shared JSON schema:

{
  "Timestamp": "2026-03-22T12:00:00.000000Z",
  "SeverityText": "INFO",
  "SeverityNumber": 9,
  "Body": "User logged in",
  "Resource": {"service.name": "my-service"},
  "TraceId": "0af7651916cd43dd8448eb211c80319c",
  "SpanId": "b7ad6b7169203331",
  "TraceFlags": "01"
}

License

Proprietary. All rights reserved.

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

otel_log-0.4.1.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

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

otel_log-0.4.1-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

Details for the file otel_log-0.4.1.tar.gz.

File metadata

  • Download URL: otel_log-0.4.1.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for otel_log-0.4.1.tar.gz
Algorithm Hash digest
SHA256 4b50c4153cc6a4f21c4f89816d1d2ad79c8eb613e15463d0f4361f20a62330f5
MD5 840263aea68fc1e6bdec774ac9f063c8
BLAKE2b-256 44cd49146b528624233328743b9338d83faed3df6d35708447a8702d53da351b

See more details on using hashes here.

File details

Details for the file otel_log-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: otel_log-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 25.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for otel_log-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 51548a9b8167371a97c62ff898d4587b099bedcecab21f880d998c919c3ec404
MD5 03ca933600fd2910b012ce52e02f7c23
BLAKE2b-256 ef3e0589315620f8d494609cb099a15a75daf09060ca4b28025a3c2b30ece980

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