Skip to content

Commit b496168

Browse files
committed
Add migrations steps and Option reference
1 parent d539fbc commit b496168

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

docs/_edot-sdks/python/migration.md

+73
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,76 @@ EDOT Python does not implement [span compression](https://www.elastic.co/guide/e
6767
### Breakdown metrics
6868

6969
EDOT Python is not sending metrics that power the [Breakdown metrics](https://www.elastic.co/guide/en/apm/guide/current/data-model-metrics.html#_breakdown_metrics).
70+
71+
## Migration steps
72+
73+
- remove any configuration and setup code needed by Elastic APM Python Agent from your application source code.
74+
- migrate any eventual usage of Elastic APM Python Agent API for manual instrumentation with OpenTelemetry API in the application source code.
75+
- follow [setup documentation](setup/index) on how to install and configure EDOT Python
76+
77+
## Option reference
78+
79+
This list contains Elastic APM Python agent configuration options that can be migrated to EDOT Python configuration because they have an equivalent in OpenTelemetry:
80+
81+
<!-- keep these sorted -->
82+
* [api_key](#api_key)
83+
* [enabled](#enabled)
84+
* [environment](#environment)
85+
* [global_labels](#global_labels)
86+
* [metrics_interval](#metrics_interval)
87+
* [secret_token](#secret_token)
88+
* [server_url](#server_url)
89+
* [service_name](#service_name)
90+
* [service_version](#service_version)
91+
92+
### `api_key`
93+
94+
The Elastic [`api_key`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-api-key) option corresponds to the OpenTelemetry [OTEL_EXPORTER_OTLP_HEADERS](https://opentelemetry.io/docs/concepts/sdk-configuration/otlp-exporter-configuration/#otel_exporter_otlp_headers) option.
95+
96+
For example:`OTEL_EXPORTER_OTLP_HEADERS="Authorization=ApiKey an_api_key"`.
97+
98+
### `enabled`
99+
100+
The Elastic [`enabled`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-enabled) option corresponds to the OpenTelemetry [OTEL_SDK_DISABLED](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration) option.
101+
102+
### `environment`
103+
104+
The Elastic [`environment`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-environment) option corresponds to setting the `deployment.environment.name` key in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes).
105+
106+
For example: `OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=testing`.
107+
108+
### `global_labels`
109+
110+
The Elastic [`global_labels`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-global-labels) option corresponds to adding `key=value` comma separated pairs in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes).
111+
112+
For example: `OTEL_RESOURCE_ATTRIBUTES=alice=first,bob=second`. Such labels will result in labels.key=value attributes on the server, e.g. labels.alice=first
113+
114+
### `metrics_interval`
115+
116+
The Elastic [`metrics_interval`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-metrics_interval) corresponds to the OpenTelemetry [OTEL_METRIC_EXPORT_INTERVAL](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#periodic-exporting-metricreader) option.
117+
118+
For example: `OTEL_METRIC_EXPORT_INTERVAL=30000`.
119+
120+
### `secret_token`
121+
122+
The Elastic [`secret_token`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-secret-token) option corresponds to the OpenTelemetry [OTEL_EXPORTER_OTLP_HEADERS](https://opentelemetry.io/docs/concepts/sdk-configuration/otlp-exporter-configuration/#otel_exporter_otlp_headers) option.
123+
124+
For example: `OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"`.
125+
126+
### `server_url`
127+
128+
The Elastic [`server_url`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-server-url) option corresponds to the OpenTelemetry [`OTEL_EXPORTER_OTLP_ENDPOINT`](https://opentelemetry.io/docs/concepts/sdk-configuration/otlp-exporter-configuration/#otel_exporter_otlp_endpoint) option.
129+
130+
### `service_name`
131+
132+
The Elastic [`service_name`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-service-name) option corresponds to the OpenTelemetry [OTEL_SERVICE_NAME](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_service_name) option.
133+
134+
The service name value can also be set using [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes).
135+
136+
For example: `OTEL_RESOURCE_ATTRIBUTES=service.name=myservice`. If `OTEL_SERVICE_NAME` is set, it takes precedence over the resource attribute.
137+
138+
### `service_version`
139+
140+
The Elastic [`service_version`](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html#config-service-version) option corresponds to setting the `service.version` key in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes).
141+
142+
For example: `OTEL_RESOURCE_ATTRIBUTES=service.version=1.2.3`.

0 commit comments

Comments
 (0)