You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/get-started.md
+27-5
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ This guide shows you how to use the Elastic Distribution of OpenTelemetry Python
18
18
Before getting started, you'll need somewhere to send the gathered OpenTelemetry data, so it can be viewed and analyzed. EDOT Python supports sending data to any OpenTelemetry protocol (OTLP) endpoint, but this guide assumes you are sending data to an [Elastic Observability](https://www.elastic.co/observability) cloud deployment. You can use an existing one or set up a new one.
19
19
20
20
<details>
21
-
<summary><strong>Expand for setup instructions</strong></summary>
21
+
<summary><strong>Expand for Elastic Observability deployment setup instructions</strong></summary>
22
22
23
23
To create your first Elastic Observability deployment:
24
24
@@ -28,6 +28,17 @@ To create your first Elastic Observability deployment:
28
28
1. When the deployment is ready, click **Open** to visit your Kibana home page (for example, `https://{DEPLOYMENT_NAME}.kb.{REGION}.cloud.es.io/app/home#/getting_started`).
29
29
</details>
30
30
31
+
<details>
32
+
<summary><strong>Expand for Elastic Observability Serverless setup instructions</strong></summary>
33
+
34
+
To create your first Elastic Observability Serverless project:
35
+
36
+
1. Sign up for a [free Elastic Cloud trial](https://cloud.elastic.co/registration) or sign into an existing account.
37
+
1. Go to <https://cloud.elastic.co/home>.
38
+
1. Click **Create project**.
39
+
1. When the project is ready, click **Open** to visit your Kibana home page (for example, `https://{DEPLOYMENT_NAME}.kb.{REGION}.cloud.es.io/app/home#/getting_started`).
40
+
</details>
41
+
31
42
<!-- ✅ How to install EDOT Python -->
32
43
## Install
33
44
@@ -61,7 +72,7 @@ After installing EDOT Python, configure and initialize it to start sending data
61
72
<!-- ✅ Provide _minimal_ configuration/setup -->
62
73
### Configure EDOT Python
63
74
64
-
To configure EDOT Python, at a minimum you'll need your Elastic Observability cloud deployment's OTLP endpoint and
75
+
To configure EDOT Python, at a minimum you'll need your Elastic Observability cloud OTLP endpoint and
65
76
authorization data to set a few `OTLP_*` environment variables that will be available when running EDOT Python:
66
77
67
78
*`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.
@@ -77,16 +88,16 @@ You can find the values of the endpoint and header variables in Kibana's APM tut
77
88
1. Scroll down and select the **OpenTelemetry** option.
78
89
1. The appropriate values for `OTEL_EXPORTER_OTLP_ENDPOINT` and `OTEL_EXPORTER_OTLP_HEADERS` are shown there.
79
90
80
-
Here's an example:
91
+
Here's an example for sending data to an Elastic Cloud deployment:
> Alternatively, you can use an [APM agent key](https://www.elastic.co/guide/en/observability/current/apm-api-key.html) to authorize requests to an Elastic Observability endpoint. APM agent keys are revocable, you can have more than one of them, and you can add or remove them without restarting APM Server.
100
+
> Alternatively on deployments, you can use an [APM agent key](https://www.elastic.co/guide/en/observability/current/apm-api-key.html) to authorize requests to an Elastic Observability endpoint. APM agent keys are revocable, you can have more than one of them, and you can add or remove them without restarting APM Server.
> 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.
0 commit comments