Skip to main content

OpenTelemetry-based logger for AWS Lambda Python functions

Project description

trace0-lambda-otel-logger

OpenTelemetry-based logger for AWS Lambda Python functions.

Automatically captures all logging output, injects OTel trace context (traceId, spanId), and exports logs as OTLP JSON to the Trace0 ingest endpoint.

See the Background section for more details on why this library is needed.

How it works

logging.info() 
  → Trace0LogHandler (logging.Handler bridge)
    → BatchLogProcessor (buffers during invocation)
      → OTLPJsonLogExporter (POST to Trace0 ingest endpoint)

Based on the OpenTelemetry Logs API specification.

Installation

pip install trace0-lambda-otel-logger

Usage

1. Add as the first import in your Lambda handler module:

import trace0_lambda_otel_logger  # must be first
from trace0_lambda_otel_logger import flush

2. Call flush() at the end of every invocation:

import logging

logger = logging.getLogger(__name__)

def handler(event, context):
    try:
        return your_handler(event, context)
    finally:
        flush()  # always flush before Lambda freezes

3. Set environment variables:

OTEL_EXPORTER_OTLP_ENDPOINT=https://app.trace0hq.com/api
OTEL_EXPORTER_OTLP_HEADERS=X-API-KEY=YOUR_TRACE0_ENV_API_KEY

That's it. No changes to your existing logging calls required.

Environment Variables

Variable Required Default Description
OTEL_EXPORTER_OTLP_ENDPOINT Yes Your Trace0 ingest endpoint
OTEL_EXPORTER_OTLP_HEADERS Yes Your Trace0 API key

Log Record Format

Each log record is exported as OTLP JSON with the following fields:

{
  "timeUnixNano": "1234567890000000000",
  "severityNumber": 9,
  "severityText": "INFO",
  "body": { "stringValue": "User created" },
  "attributes": [
    { "key": "logger.name", "value": { "stringValue": "app.users" } },
    { "key": "code.function", "value": { "stringValue": "create_user" } },
    { "key": "code.lineno", "value": { "intValue": 42 } }
  ],
  "traceId": "abc123...",
  "spanId": "def456..."
}

Requirements

Background

To correlate logs with traces in Trace0, this library must be installed in your Lambda function. This is necessary because the OpenTelemetry Python Logs SDK is currently in an experimental state. The APIs within opentelemetry.sdk._logs are subject to change in minor/patch releases and make no backward compatibility guarantees at this time.

trace0-lambda-otel-logger solves this gap by installing a logging.Handler on the root logger that automatically injects the active OTel span's traceId and spanId into every log record, and exporting them directly to the Trace0 ingest endpoint. This enables full log-trace correlation with minimal integration effort.

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

trace0_lambda_otel_logger-1.0.3.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

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

trace0_lambda_otel_logger-1.0.3-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file trace0_lambda_otel_logger-1.0.3.tar.gz.

File metadata

File hashes

Hashes for trace0_lambda_otel_logger-1.0.3.tar.gz
Algorithm Hash digest
SHA256 ab49c9a77adfd954134ae90aac3e2dfbb3311cd3ddcbb5e8d70245b39e9ba156
MD5 839955910db1e92bd01a446f69a95919
BLAKE2b-256 a1c4b1e67cda02c635aa47cf90401fedd6b374ef1457ea2d2f35dcca73beb89e

See more details on using hashes here.

Provenance

The following attestation bundles were made for trace0_lambda_otel_logger-1.0.3.tar.gz:

Publisher: publish.yml on Trace0-HQ/trace0-lambda-python-otel-logger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file trace0_lambda_otel_logger-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for trace0_lambda_otel_logger-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f43b0385ad940334a09a8b3d533d31ee2d6eaaa8c2f3cecf285989484381914d
MD5 40094f3fe0b51f4f422964d22ae3a0dd
BLAKE2b-256 44328748a5217b12351230d49f72896362e9921818f2c8db88ea5460ff07f3b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for trace0_lambda_otel_logger-1.0.3-py3-none-any.whl:

Publisher: publish.yml on Trace0-HQ/trace0-lambda-python-otel-logger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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