Skip to main content
Configure the Lumina Python SDK.

Basic Configuration

from lumina import init_lumina

lumina = init_lumina({
    "endpoint": "http://localhost:9411/v1/traces",
    "service_name": "my-service",
})

Configuration Options

OptionTypeRequiredDefaultDescription
endpointstrYesOTLP trace endpoint URL
service_namestrNo"unknown-service"Service identifier
api_keystrNoBearer token (omit for self-hosted)
environmentstrNo"live""live" or "test"
customer_idstrNoCustomer identifier
enabledboolNoTrueEnable/disable tracing
batch_sizeintNo10Max spans per export batch
batch_interval_msintNo5000Batch flush interval (ms)
timeout_msintNo30000Export timeout (ms)
max_retriesintNo3Export retry count

Environment-Based Configuration

All options can be set via environment variables — no code changes needed across environments:
import os
from lumina import init_lumina

lumina = init_lumina({
    "endpoint": os.environ.get("LUMINA_ENDPOINT", "http://localhost:9411/v1/traces"),
    "service_name": os.environ.get("LUMINA_SERVICE_NAME", "my-service"),
    "enabled": os.environ.get("LUMINA_ENABLED", "true").lower() != "false",
})
Or rely entirely on environment variables (the SDK reads them automatically):
export LUMINA_ENDPOINT=http://localhost:9411/v1/traces
export LUMINA_SERVICE_NAME=my-service
export LUMINA_API_KEY=lumina_...        # optional
export LUMINA_ENVIRONMENT=live
from lumina import init_lumina

lumina = init_lumina()  # reads all LUMINA_* env vars automatically

Environment Variables Reference

VariableDefaultDescription
LUMINA_ENDPOINThttp://localhost:9411/v1/tracesOTLP collector URL
LUMINA_API_KEYAPI key (omit for self-hosted)
LUMINA_SERVICE_NAMEService name
LUMINA_ENVIRONMENTlivelive or test
LUMINA_CUSTOMER_IDCustomer identifier
LUMINA_ENABLEDtrueSet to false to disable
LUMINA_BATCH_SIZE10Max spans per batch
LUMINA_BATCH_INTERVAL_MS5000Batch flush interval
LUMINA_MAX_RETRIES3Export retry count
LUMINA_TIMEOUT_MS30000Export timeout

Cloud / Managed Lumina

To send traces to Lumina Cloud, set your endpoint and API key:
from lumina import init_lumina

lumina = init_lumina({
    "endpoint": "https://collector.uselumina.io/v1/traces",
    "api_key": "lumina_...",
    "service_name": "my-service",
    "environment": "live",
})

Next Steps