Send logs from Python

Send Python logs to Rootprint through the standard logging module, with the OpenTelemetry SDK’s OTLPLogExporter sending them over OTLP HTTP (http/protobuf).

Prerequisites

A running Rootprint instance. Substitute its host for <your-rootprint>.
Python 3.10+ with pip.
An ingest API key scoped to an OpenTelemetry logs index such as otel-logs-v0_9. In Settings → API keys, click Create ingest key and pick the index. See API keys.

Setup

Install the OpenTelemetry SDK

pip install opentelemetry-sdk opentelemetry-exporter-otlp-proto-http opentelemetry-instrumentation-logging

opentelemetry-instrumentation-logging provides the LoggingHandler that bridges the standard logging module.

Set environment variables

export OTEL_SERVICE_NAME=my-python-service
export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT='https://<your-rootprint>/v1/logs'
export OTEL_EXPORTER_OTLP_LOGS_HEADERS='Authorization=Bearer%20<your-ingest-api-key>'

The %20 after Bearer is required: OpenTelemetry SDKs expect URL-encoded values in OTEL_EXPORTER_OTLP_LOGS_HEADERS.

Minimal working example

import logging
from opentelemetry._logs import set_logger_provider
from opentelemetry.sdk._logs import LoggerProvider
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
from opentelemetry.instrumentation.logging.handler import LoggingHandler

logger_provider = LoggerProvider()
set_logger_provider(logger_provider)
logger_provider.add_log_record_processor(BatchLogRecordProcessor(OTLPLogExporter()))

logging.getLogger().addHandler(LoggingHandler(logger_provider=logger_provider))
logging.getLogger().setLevel(logging.INFO)

logging.info("Hello from Python to Rootprint")

# BatchLogRecordProcessor buffers records. Short-lived scripts must flush
# (or shut the provider down) before exit, otherwise the batch is dropped.
logger_provider.shutdown()

Verify in Rootprint

Open Logs, filter on service_name:my-python-service, and your record should appear within a few seconds.

Structured logging

Pass attributes in the extra argument of the standard logging API:

logging.info("user signed up", extra={"user_id": "alice", "plan": "pro"})

They land under attributes.user_id and attributes.plan, and you can search and filter on them.

Framework recipe: FastAPI

Set up the provider once at startup, in the app’s lifespan handler, so every worker process picks it up.

from contextlib import asynccontextmanager
from fastapi import FastAPI
import logging
from opentelemetry._logs import set_logger_provider
from opentelemetry.sdk._logs import LoggerProvider
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
from opentelemetry.instrumentation.logging.handler import LoggingHandler

@asynccontextmanager
async def lifespan(app: FastAPI):
    provider = LoggerProvider()
    set_logger_provider(provider)
    provider.add_log_record_processor(BatchLogRecordProcessor(OTLPLogExporter()))
    logging.getLogger().addHandler(LoggingHandler(logger_provider=provider))
    logging.getLogger().setLevel(logging.INFO)
    yield
    provider.shutdown()

app = FastAPI(lifespan=lifespan)

@app.get("/")
def index():
    logging.info("request received", extra={"route": "/"})
    return {"ok": True}

Troubleshooting

401 or 403: the ingest API key is missing or wrong, or the space after Bearer isn’t written as %20. Check OTEL_EXPORTER_OTLP_LOGS_HEADERS. See Response codes.
200 but no records in Logs: the ingest API key is scoped to an index without the OpenTelemetry logs schema, so the records are discarded. See Index target.
Nothing in Logs from a short-lived script: the batch processor buffers records. Shut down the logger provider before exit, as the minimal example does.
TLS errors against a self-signed endpoint: set OTEL_EXPORTER_OTLP_CERTIFICATE=/path/to/ca.pem.

OTLP reference: endpoint URL, response codes, env-var table
Indexes: otel-logs-v0_9 schema and custom-index concepts
Manage indexes: map log level, message, and traceback fields

Get Started

Send Logs

Traces

Search Logs

Manage Rootprint

Send logs from Python

Prerequisites

Setup

Structured logging

Framework recipe: FastAPI

Troubleshooting

​Prerequisites

​Setup

​Structured logging

​Framework recipe: FastAPI

​Troubleshooting

​Related

Prerequisites

Setup

Structured logging

Framework recipe: FastAPI

Troubleshooting

Related