Migrate to the Splunk Python 2.0 instrumentation 🔗
OpenTelemetry Python instrumentation 2.0 contains a set of breaking changes introduced with the OpenTelemetry semantic conventions updates.
This migration guide assumes that you’re using a 1.x version of the Splunk Distribution of OpenTelemetry Python.
Prerequisites 🔗
To migrate to the Splunk Distribution of OpenTelemetry Python version 2.0, you need the following:
Splunk Distribution of OpenTelemetry Collector version 0.98 or higher deployed.
Administrator permissions for Splunk Observability Cloud.
pip version 3.0 or higher.
Migrate to Splunk OTel Python 2.0 🔗
Upgrading to Splunk OTel Python 2.0 requires upgrading the Splunk Distribution of OpenTelemetry Collector.
To upgrade to Splunk OTel Python 2.0, follow these steps:
Open a terminal.
Enter the following command:
pip install --upgrade splunk-opentelemetry
Restart any running Python applications that you plan to instrument.
Instrumentation parameters for Python 2.0 🔗
Splunk OpenTelemetry Python version 2.0 changes the parameters for zero-code instrumentation.
See the following table for a list of changes:
Version 1.x name |
Version 2.0 name |
Description |
|---|---|---|
splunk-py-trace, splk-py-trace |
opentelemetry-instrument |
Activates the Splunk OpenTelemetry Python agent and sends traces and metrics to Splunk Observability Cloud. |
splunk-py-trace-bootstrap, splk-py-trace-bootstrap |
opentelemetry-bootstrap |
Installs instrumentation libraries and dependencies for Splunk OpenTelemetry Python. |
Function names for Python 2.0 🔗
Functions configure certain telemetry data settings in your Python application code.
See the following table for new function names in Python 2.0:
Version 1.x name |
Version 2.0 name |
Description |
|---|---|---|
start_tracing(), start_metrics() |
init_splunk_otel() |
Configures tracing, metrics, and logs for Splunk OpenTelemetry Python. |
Troubleshooting 🔗
If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.
Available to Splunk Observability Cloud customers
Submit a case in the Splunk Support Portal .
Contact Splunk Support .
Available to prospective customers and free trial users
Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.