splunk-opentelemetry
Splunk Distribution of OpenTelemetry Python
The Splunk distribution of OpenTelemetry Python provides multiple installable packages that automatically instrument your Python application to capture and report distributed traces to Splunk APM. Instrumentation works by patching supported libraries at runtime with an OpenTelemetry-compatible tracer to capture and export trace spans.
This distribution comes with the following defaults:
- OTLP gRPC exporter
configured to send spans to a locally running
Splunk OpenTelemetry Collector
(
http://localhost:4317). - Unlimited default limits for configuration options to support full-fidelity traces.
- Inclusion of system metrics
Requirements
This Splunk Distribution of OpenTelemetry requires Python 3.10 or later. Supported libraries are listed here.
Get started
For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Python, see Instrument a Python application for Splunk Observability Cloud in the official documentation.
For the standard OpenTelemetry setup, install the Splunk distribution in your application environment. The distribution configures OTLP exporters for traces, metrics, and logs, includes system metrics instrumentation, and enables Python logging instrumentation.
pip install splunk-opentelemetry
Install instrumentation packages for the libraries your application uses:
opentelemetry-bootstrap -a install
Then run your application with opentelemetry-instrument:
OTEL_SERVICE_NAME=my-python-service opentelemetry-instrument python app.py
By default, OTLP exporters send telemetry to a locally running
Splunk OpenTelemetry Collector
at http://localhost:4317. To send telemetry directly to Splunk Observability
Cloud instead, set SPLUNK_REALM and SPLUNK_ACCESS_TOKEN before starting your
application. SPLUNK_REALM configures direct ingest endpoints for traces and
metrics.
Optional: Cisco SecureApp
To also install the Cisco SecureApp
OpenTelemetry extension, specify the secureapp extra:
pip install "splunk-opentelemetry[secureapp]"
This extra installs the SecureApp Python agent, which reports runtime Python package dependencies through OpenTelemetry logs.
SecureApp dependency logs use the secureapp instrumentation scope. Collector
deployments must route those logs to the SecureApp event ingest endpoint
(/v3/event) and add the SecureApp instrumentation header on the outbound
exporter. See docs/secureapp.md for setup details and
docs/examples/secureapp-collector-config.yaml
for a collector example.
Fleet Management with OpAMP
Splunk OTel Python provides OpAMP support. When enabled, the OpAMP client connects to the configured endpoint and reports the Python agent's status and settings. Agents connected to Splunk Observability Cloud appear on the Fleet Management page.
The default OpAMP endpoint is a local Splunk OpenTelemetry Collector. Set
SPLUNK_OPAMP_ENDPOINT to use another OpAMP endpoint. See
OpAMP for setup and limits.
License
The Splunk distribution of OpenTelemetry Python Instrumentation is a distribution of OpenTelemetry Python. It is licensed under the terms of the Apache Software License version 2.0. See the license file for more details.
Deprecation
ℹ️ The Splunk Distribution of OpenTelemetry Python version 1.X is deprecated as of February 28, 2025 and will reach end of support on February 28, 2026. Existing customers should consider migrating to Splunk OpenTelemetry Python 2.0 or higher. See Migrate to the Splunk Python 2.0 instrumentation.
1 maintainer
Metadata
1 maintainer
Release files for splunk-opentelemetry 2.12.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| splunk_opentelemetry-2.12.1.tar.gz | 63.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| splunk_opentelemetry-2.12.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 88.2 kB
Release files / splunk_opentelemetry-2.12.1.tar.gz
| Download URL | splunk_opentelemetry-2.12.1.tar.gz |
|---|---|
| Size | 63.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a76590faeceaf8dcfc8a261927de7d27794dd8570d61e79b9fb4f750bcce63b9
|
|
BLAKE2b-256 checksum How to use checksums |
fb80abd7f3f029d10074860e73add5e6acc672bac8b9e36d0041c6293b547111
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.17.1 {"ci":true,"cpu":"x86_64","distro":{"id":"trixie","libc":{"lib":"glibc","version":"2.41"},"name":"Debian GNU/Linux","version":"13"},"implementation":{"name":"CPython","version":"3.11.15"},"installer":{"name":"hatch","version":"1.17.1"},"openssl_version":"OpenSSL 3.5.6 7 Apr 2026","python":"3.11.15","system":{"name":"Linux","release":"5.15.0-1084-aws"}} HTTPX2/2.9.1
|
Release files / splunk_opentelemetry-2.12.1-py3-none-any.whl
| Download URL | splunk_opentelemetry-2.12.1-py3-none-any.whl |
|---|---|
| Size | 24.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bebaa0fdb84e4e58b5df1623ea9b0021be61a003c5ee3ea6ef3a17a7b83ddcfc
|
|
BLAKE2b-256 checksum How to use checksums |
652aaf0dbd31f3d386bdec2084ad8103c365d8e3135c33d5ad6626999d1a1a96
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.17.1 {"ci":true,"cpu":"x86_64","distro":{"id":"trixie","libc":{"lib":"glibc","version":"2.41"},"name":"Debian GNU/Linux","version":"13"},"implementation":{"name":"CPython","version":"3.11.15"},"installer":{"name":"hatch","version":"1.17.1"},"openssl_version":"OpenSSL 3.5.6 7 Apr 2026","python":"3.11.15","system":{"name":"Linux","release":"5.15.0-1084-aws"}} HTTPX2/2.9.1
|
