otel-metry 0.2.0

Zero-config OpenTelemetry auto-instrumentation for Flask apps with CubeAPM

otel-metry

Zero-config OpenTelemetry auto-instrumentation for Flask apps. One init() call and your app exports traces and metrics to CubeAPM (or any OTLP-compatible backend).

Installation

pip install otel-metry

With optional instrumentors:

pip install otel-metry[all]        # requests, sqlalchemy, redis, psycopg2, celery
pip install otel-metry[requests]   # just requests

Quick Start

import otelmetry
otelmetry.init(endpoint="http://cubeapm:4317", service_name="my-app")

from flask import Flask
app = Flask(__name__)

@app.route("/")
def hello():
    return "Hello World"

That's it. All Flask requests, database queries, and outgoing HTTP calls are traced automatically.

Configuration

Programmatic

otelmetry.init(
    endpoint="http://cubeapm:4317",
    service_name="my-app",
    insecure=True,
    resource_attributes={"deployment.environment": "production"},
)

Environment Variables

Variable	Fallback	Default
OTEL_METRY_ENDPOINT	OTEL_EXPORTER_OTLP_ENDPOINT	http://localhost:4317
OTEL_METRY_SERVICE_NAME	OTEL_SERVICE_NAME	unknown-service
OTEL_METRY_INSECURE	—	true
OTEL_METRY_ENABLED	—	true

Zero-Code (env vars only)

export OTEL_METRY_ENDPOINT=http://cubeapm:4317
export OTEL_METRY_SERVICE_NAME=my-app

import otelmetry.auto  # auto-initializes from env vars

from flask import Flask
app = Flask(__name__)

Auto-Instrumented Libraries

If installed, the following are instrumented automatically:

• Flask (always)
• requests — outgoing HTTP calls
• SQLAlchemy — database queries
• Redis — cache operations
• psycopg2 — PostgreSQL queries
• Celery — task queues

API

otelmetry.init(...)       # Initialize (call once)
otelmetry.shutdown()      # Flush and stop (called automatically on exit)
otelmetry.get_tracer(name)  # Get a tracer for manual spans
otelmetry.get_meter(name)   # Get a meter for custom metrics

With Gunicorn

# gunicorn.conf.py
def post_fork(server, worker):
    import otelmetry
    otelmetry.init(endpoint="http://cubeapm:4317", service_name="my-app")