Skip to content

Commit d539fbc

Browse files
committed
Simpligy setup instructions and refer to general onboarding page
1 parent 5279170 commit d539fbc

File tree

2 files changed

+9
-41
lines changed

2 files changed

+9
-41
lines changed

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

+7-30
Original file line numberDiff line numberDiff line change
@@ -39,40 +39,17 @@ After installing EDOT Python, configure and initialize it to start sending data
3939
<!-- ✅ Provide _minimal_ configuration/setup -->
4040
### Configure EDOT Python
4141

42-
To configure EDOT Python, at a minimum you'll need your Elastic Observability cloud OTLP endpoint and
43-
authorization data to set a few `OTLP_*` environment variables that will be available when running EDOT Python:
42+
Refer to [Observability quickstart](https://elastic.github.io/opentelemetry/quickstart/) documentation on how to setup your environment.
4443

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.
46-
* `OTEL_EXPORTER_OTLP_ENDPOINT`: The full URL of the endpoint where data will be sent.
47-
* `OTEL_EXPORTER_OTLP_HEADERS`: A comma-separated list of `key=value` pairs that will
48-
be added to the headers of every request. This is typically used for authentication information.
49-
50-
You can find the values of the endpoint and header variables in Kibana's APM tutorial. In Kibana:
51-
52-
1. Go to **Setup guides**.
53-
1. Select **Observability**.
54-
1. Select **Monitor my application performance**.
55-
1. Scroll down and select the **OpenTelemetry** option.
56-
1. The appropriate values for `OTEL_EXPORTER_OTLP_ENDPOINT` and `OTEL_EXPORTER_OTLP_HEADERS` are shown there.
57-
58-
Here's an example for sending data to an Elastic Cloud deployment:
44+
To configure EDOT Python you need to set a few `OTLP_*` environment variables that will be available when running EDOT Python:
5945

60-
```sh
61-
export OTEL_RESOURCE_ATTRIBUTES=service.name=<app-name>,service.version=<app-version>,deployment.environment=production
62-
export OTEL_EXPORTER_OTLP_ENDPOINT=https://my-deployment.apm.us-west1.gcp.cloud.es.io
63-
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer P....l"
64-
```
46+
* `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.
6547

66-
And here's an example for sending data to an Elastic Cloud serverless project:
48+
The following environment variables are not required if you are sending data through a local EDOT Collector but will be provided in the Elastic Observability platform onboarding:
6749

68-
```sh
69-
export OTEL_RESOURCE_ATTRIBUTES=service.name=<app-name>,service.version=<app-version>,deployment.environment=production
70-
export OTEL_EXPORTER_OTLP_ENDPOINT=https://my-deployment.apm.us-west1.gcp.cloud.es.io
71-
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=ApiKey B....="
72-
```
50+
* `OTEL_EXPORTER_OTLP_ENDPOINT`: The full URL of the endpoint where data will be sent.
51+
* `OTEL_EXPORTER_OTLP_HEADERS`: A comma-separated list of `key=value` pairs that will be added to the headers of every request. This is typically used for authentication information.
7352

74-
> [!NOTE]
75-
> You'll be prompted to create an API key during the Elastic Cloud serverless project onboarding. Refer to the [Api keys documentation](https://www.elastic.co/guide/en/serverless/current/api-keys.html) on how to manage them.
7653

7754
### Run EDOT Python
7855

@@ -93,7 +70,7 @@ opentelemetry-instrument gunicorn main:app
9370

9471
To confirm that EDOT Python has successfully connected to Elastic:
9572

96-
1. Go to **APM****Services**
73+
1. Go to **Observability****Applications****Service Inventory**
9774
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.
9875
1. Click on the name in the list to see trace data.
9976

docs/_edot-sdks/python/setup/manual-instrumentation.md

+2-11
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,7 @@ This guide requires to have already added auto-instrumentation with OpenTelemetr
1717
<!-- ✅ Provide _minimal_ configuration/setup -->
1818
### Configure EDOT Python
1919

20-
To configure EDOT Python, at a minimum you'll need your Elastic Observability cloud deployment's OTLP endpoint and
21-
authorization data to set a few `OTLP_*` environment variables that will be available when running EDOT Python:
22-
23-
```sh
24-
export OTEL_RESOURCE_ATTRIBUTES=service.name=<app-name>
25-
export OTEL_EXPORTER_OTLP_ENDPOINT=https://my-deployment.apm.us-west1.gcp.cloud.es.io
26-
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer P....l"
27-
```
28-
29-
Refer to our [Setup](./index) page for more details.
20+
Refer to our [Setup](./index#configure-EDOT-Python) page for more details.
3021

3122
<!-- ✅ Manually instrument the application and start sending data to Elastic -->
3223
### Manually instrument your auto instrumented Python application
@@ -107,7 +98,7 @@ def hello():
10798

10899
To confirm that EDOT Python has successfully connected to Elastic:
109100

110-
1. Go to **APM****Traces**.
101+
1. Go to **Observability****Applications****Service Inventory**
111102
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.
112103
1. Click on the name in the list to see trace data.
113104

0 commit comments

Comments
 (0)