OwlpaneDOCS
Reference

Environment variables

Canonical environment variables read by Owlpane SDKs, and by stock OpenTelemetry instrumentation pointed at Owlpane. Each value applies to the process that runs your app or collector; the ingest key selects the destination project.

SDK variables

VariablePurposeDefault
OTEL_EXPORTER_OTLP_ENDPOINTOTLP/HTTP base URL. Checked first.—
OWLPANE_INGEST_URLOTLP/HTTP base URL, used when OTEL_EXPORTER_OTLP_ENDPOINT is unset.https://ingest.owlpane.com
OWLPANE_INGEST_KEYProject ingest key (owl_ing_…).—
OTEL_SERVICE_NAMEValue of the service.name resource attribute.node-app
OWLPANE_ENVIRONMENTdeployment.environment.name; falls back to OTEL_RESOURCE_ATTRIBUTES / NODE_ENV.—
OWLPANE_RELEASERelease/version shown on the Releases surface.—
OTEL_SDK_DISABLED=trueSwitches the SDK off entirely.unset
OTEL_TRACES_SAMPLER_ARGTrace sampling ratio.1.0
OWLPANE_METRICS_EXPORT_INTERVAL_MSMetric export interval, in milliseconds.30000
OWLPANE_TRACE_USER_PROFILE=1Opt in to attaching email/name on setUser (discouraged in production).unset
OWLPANE_PROFILING=1Opt-in CPU profiling.unset
OWLPANE_LIVE_DEBUGGER=1Opt-in live debugger; requires OWLPANE_API_URL. Node.js only.unset
OTEL_EXPORTER_OTLP_PROTOCOLRecommended protocol value in examples.http/protobuf

The resolved OTLP/HTTP endpoint is OTEL_EXPORTER_OTLP_ENDPOINT if set, otherwise OWLPANE_INGEST_URL, otherwise the Owlpane default https://ingest.owlpane.com.

Example

export OTEL_EXPORTER_OTLP_ENDPOINT="https://ingest.owlpane.com"
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
export OWLPANE_INGEST_KEY="owl_ing_your_key_here"
export OTEL_SERVICE_NAME="checkout-service"
export OWLPANE_ENVIRONMENT="production"

Public service hosts

ServiceHost
Telemetry ingest (OTLP HTTP and gRPC)ingest.owlpane.com
Control-plane APIapi.owlpane.com
Web consoleconsole.owlpane.com
Documentationdocs.owlpane.com

Ingest key format

An ingest key is owl_ing_ followed by 48 hexadecimal characters. It is write-only and scoped to a single project. Pass it as Authorization: Bearer owl_ing_… — see Ingest keys & authentication.

Last updated

On this page