Skip to content

Commit b39b8a2

Browse files
xrmxAlexanderWert
andauthoredMar 20, 2025··
Apply suggestions from code review
Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
1 parent 06e3d62 commit b39b8a2

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed
 

‎docs/_edot-sdks/python/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 6
77
## EDOT Python
88

99
The [Elastic Distribution of OpenTelemetry Python (EDOT Python)](https://github.com/elastic/elastic-otel-python) is a customized version of [OpenTelemetry Python](https://opentelemetry.io/docs/languages/python).
10-
EDOT Python makes it easier to get started using OpenTelemetry in your Python applications through strictly OpenTelemetry native means, while also providing a smooth and rich out of the box experience with [Elastic Observability](https://www.elastic.co/observability). It's an explicit goal of this distribution to introduce **no new concepts** in addition to those defined by the wider OpenTelemetry community.
10+
EDOT Python makes it easier to get started using OpenTelemetry in your Python applications through strictly OpenTelemetry native means, while also providing a smooth and rich out of the box experience with [Elastic Observability](https://www.elastic.co/observability). It's an explicit goal of this distribution **to avoid introducing proprietary concepts** in addition to those defined by the wider OpenTelemetry community. For any additional features introduced we aim for contributing them back to the upstream OpenTelemetry Python project.
1111

1212
With EDOT Python you have access to all the features of the OpenTelemetry Python agent plus:
1313

‎docs/_edot-sdks/python/migration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For step-by-step instructions on setting up EDOT Python refer to the [Setup](./s
1414

1515
As a distribution of OpenTelemetry, EDOT Python follows certain standards, but there is still some space for innovation.
1616

17-
## Bold on autoinstrumentation
17+
## Bold on auto-instrumentation
1818

1919
We have chosen to make autoinstrumentation as simple as possible so you can just focus on your code; we favored an experience that requires minimal changes to your application code. The upstream OpenTelemetry configuration has more options than the distribution requires. Our default configuration is listed [here](https://github.com/elastic/elastic-otel-python?tab=readme-ov-file#configuration).
2020

@@ -25,10 +25,10 @@ We provide a tool to discover available instrumentations automatically that can
2525

2626
## Performance comparison
2727

28-
Any instrumentation agent will incur in a performance penalty for your application because more work will be done. How much really depends
28+
Every instrumentation agent comes with a (small) performance overhead for your application. How much really depends
2929
on your application and on the instrumentations used.
3030

31-
While we can't provide generically applicable, accurate numbers about the performance penalty, here you can find some measurement taken
31+
While we can't provide generically applicable, accurate numbers about the performance overhead, here you can find some measurement taken
3232
from a sample web application which allows to provide a comparison between agents and an order of magnitude of the effective overhead.
3333

3434
Those numbers are only provided as indicators, and you should not attempt to extrapolate them. You should however use

‎docs/_edot-sdks/python/setup/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ After installing EDOT Python, configure and initialize it to start sending data
4242
To configure EDOT Python, at a minimum you'll need your Elastic Observability cloud OTLP endpoint and
4343
authorization data to set a few `OTLP_*` environment variables that will be available when running EDOT Python:
4444

45-
* `OTEL_RESOURCE_ATTRIBUTES`: Use this to add a service name that will make it easier to recognize your application when reviewing data sent to Elastic.
45+
* `OTEL_RESOURCE_ATTRIBUTES`: Use this to add a `service.name` and `deployment.environment` that will make it easier to recognize your application when reviewing data sent to Elastic.
4646
* `OTEL_EXPORTER_OTLP_ENDPOINT`: The full URL of the endpoint where data will be sent.
4747
* `OTEL_EXPORTER_OTLP_HEADERS`: A comma-separated list of `key=value` pairs that will
4848
be added to the headers of every request. This is typically used for authentication information.
@@ -93,9 +93,9 @@ opentelemetry-instrument gunicorn main:app
9393

9494
To confirm that EDOT Python has successfully connected to Elastic:
9595

96-
1. Go to **APM****Traces**.
96+
1. Go to **APM****Services**
9797
1. You should see the name of the service to which you just added EDOT Python. It can take several minutes after initializing EDOT Python for the service to show up in this list.
9898
1. Click on the name in the list to see trace data.
9999

100100
> [!NOTE]
101-
> There may be no trace data to visualize unless you have _used_ your application since initializing EDOT Python.
101+
> There may be no trace data to visualize unless you have _invoked_ your application since initializing EDOT Python.

0 commit comments

Comments
 (0)