-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add manual instrumentation docs (#189)
* WIP manual instrumentation * Add manual instrumentation to an automatically instrumented application * Create a span only for the choice * Fix code examples * Update docs/manual-instrumentation.md Co-authored-by: Edu González de la Herrán <[email protected]> * Consider manual instrumentation as next step for get-started To drop most of duplicated content. Add cross reference between the two documents. * Drop opentelemetry-instrument call from configuration chapter * Reference manual instrumentation in README * Update docs/manual-instrumentation.md Co-authored-by: Emily S <[email protected]> --------- Co-authored-by: Edu González de la Herrán <[email protected]> Co-authored-by: Emily S <[email protected]>
- Loading branch information
1 parent
97a7e93
commit 1e1f379
Showing
3 changed files
with
119 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
<!-- | ||
Goal of this doc: | ||
The user is able to manually instrument their Python application | ||
--> | ||
|
||
# Manual instrumentation | ||
|
||
This guide shows you how to use the Elastic Distribution of OpenTelemetry Python (EDOT Python) to manually instrument your Python application and send OpenTelemetry data to an Elastic Observability deployment. | ||
|
||
This guide requires to have already added autoinstrumentation with OpenTelemetry to your application per [Get started](./get-started.md). | ||
|
||
**New to OpenTelemetry?** If your are new to OpenTelemetry we encourage you to take a look at our [get started documentation](./get-started.md) instead, which will introduce you to autoinstrumentation. | ||
|
||
<!-- ✅ Provide _minimal_ configuration/setup --> | ||
### Configure EDOT Python | ||
|
||
To configure EDOT Python, at a minimum you'll need your Elastic Observability cloud deployment's OTLP endpoint and | ||
authorization data to set a few `OTLP_*` environment variables that will be available when running EDOT Python: | ||
|
||
```sh | ||
export OTEL_RESOURCE_ATTRIBUTES=service.name=<app-name> | ||
export OTEL_EXPORTER_OTLP_ENDPOINT=https://my-deployment.apm.us-west1.gcp.cloud.es.io | ||
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer P....l" | ||
``` | ||
|
||
Refer to our [get started](./get-started.md) page for more details. | ||
|
||
<!-- ✅ Manually instrument the application and start sending data to Elastic --> | ||
### Manually instrument your auto instrumented Python application | ||
|
||
In this section we'll show how to add manual instrumentation to an already automatically instrumented application. A use case for | ||
this setup would be to trace something in particular while keeping the benefits of the simplicity of the automatic instrumentation doing | ||
the hard work for us. | ||
|
||
As an example we'll use an application using the Flask framework that implements an endpoint mounted on `/hello` returning a friendly | ||
salute. This application is saved in a file named `app.py` that is the default module for Flask applications. | ||
|
||
``` | ||
import random | ||
from flask import Flask | ||
from opentelemetry import trace | ||
tracer = trace.get_tracer(__name__) | ||
app = Flask(__name__) | ||
@app.route("/hello") | ||
def hello(): | ||
choices = ["there", "world", "folks", "hello"] | ||
# create a span for the choice of the name, this may be a costly call in your real world application | ||
with tracer.start_as_current_span("choice") as span: | ||
choice = random.choice(choices) | ||
span.set_attribute("choice.value", choice) | ||
return f"Hello {choice}!" | ||
``` | ||
|
||
We need to make sure to have Flask and the Flask OpenTelemetry instrumentation installed: | ||
|
||
```bash | ||
pip install flask | ||
opentelemetry-bootstrap --action=install | ||
``` | ||
|
||
And then we can run this application with the following command: | ||
|
||
```bash | ||
opentelemetry-instrument flask run | ||
``` | ||
|
||
We may not only need to add a custom span to our application but also want to use a custom metric, like in the example below where we | ||
are tracking how many times we are getting one of the possible choices for our salutes. | ||
|
||
``` | ||
import random | ||
from flask import Flask | ||
from opentelemetry import metrics, trace | ||
tracer = trace.get_tracer(__name__) | ||
meter = metrics.get_meter(__name__) | ||
hello_counter = meter.create_counter( | ||
"hello.choice", | ||
description="The number of times a salute is chosen", | ||
) | ||
app = Flask(__name__) | ||
@app.route("/hello") | ||
def hello(): | ||
choices = ["there", "world", "folks", "hello"] | ||
# create a span for the choice of the name, this may be a costly call in your real world application | ||
with tracer.start_as_current_span("choice") as span: | ||
choice = random.choice(choices) | ||
span.set_attribute("choice.value", choice) | ||
hello_counter.add(1, {"choice.value": choice}) | ||
return f"Hello {choice}!" | ||
``` | ||
|
||
<!-- ✅ What success looks like --> | ||
## Confirm that EDOT Python is working | ||
|
||
To confirm that EDOT Python has successfully connected to Elastic: | ||
|
||
1. Go to **APM** → **Traces**. | ||
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. | ||
1. Click on the name in the list to see trace data. | ||
|
||
> [!NOTE] | ||
> There may be no trace data to visualize unless you have _used_ your application since initializing EDOT Python. | ||
<!-- ✅ What they should do next --> | ||
## Next steps | ||
|
||
* Reference all available [configuration options](./configure.md). | ||
* Learn more about viewing and interpreting data in the [Observability guide](https://www.elastic.co/guide/en/observability/current/apm.html). |