Document and enable OpenTelemetry instrumentation

Author: pquentin

docs/guide/images/otel-waterfall-with-http.png

@@ -4,6 +4,13 @@
 You can find integration options and information on this page.
 
 
+[discrete]
+[[opentelemetry]]
+=== OpenTelemetry instrumentation
+
+The Python Elasticsearch client supports native OpenTelemetry instrumentation following the https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/[OpenTelemetry Semantic Conventions for Elasticsearch].
+Refer to the <<opentelemetry>> page for details.
+
 [discrete]
 [[transport]]
 === Transport
@@ -53,3 +60,6 @@ es.options(
 ------------------------------------
 
 Type hints also allow tools like your IDE to check types and provide better auto-complete functionality.
+
+
+include::open-telemetry.asciidoc[]

docs/guide/images/otel-waterfall-without-http.png

@@ -0,0 +1,66 @@
+[[opentelemetry]]
+=== Using OpenTelemetry
+
+You can use https://opentelemetry.io/[OpenTelemetry] to monitor the performance and behavior of your {es} requests through the Elasticsearch Python Client.
+The Python Client comes with built-in OpenTelemetry instrumentation that emits https://www.elastic.co/guide/en/apm/guide/current/apm-distributed-tracing.html[distributed tracing spans] by default.
+With that, applications https://opentelemetry.io/docs/languages/python/instrumentation/[manually instrumented with OpenTelemetry] or using the https://opentelemetry.io/docs/languages/python/automatic/[OpenTelemetry Python agent] are enriched with additional spans that contain insightful information about the execution of the {es} requests.
+
+The native instrumentation in the Python Client follows the https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/[OpenTelemetry Semantic Conventions for {es}]. In particular, the instrumentation in the client covers the logical layer of {es} requests. A single span per request is created that is processed by the service through the Python Client. The following image shows a trace that records the handling of two different {es} requests: an `info` request and a `search` request.
+
+[role="screenshot"]
+image::images/otel-waterfall-without-http.png[alt="Distributed trace with Elasticsearch spans",align="center"]
+
+Usually, OpenTelemetry auto-instrumentation modules come with instrumentation support for HTTP-level communication. In this case, in addition to the logical {es} client requests, spans will be captured for the physical HTTP requests emitted by the client. The following image shows a trace with both, {es} spans (in blue) and the corresponding HTTP-level spans (in red):
+
+[role="screenshot"]
+image::images/otel-waterfall-with-http.png[alt="Distributed trace with Elasticsearch spans",align="center"]
+
+Advanced Python Client behavior such as nodes round-robin and request retries are revealed through the combination of logical {es} spans and the physical HTTP spans. The following example shows a `search` request in a scenario with two nodes:
+
+[role="screenshot"]
+image::images/otel-waterfall-retry.png[alt="Distributed trace with Elasticsearch spans",align="center"]
+
+The first node is unavailable and results in an HTTP error, while the retry to the second node succeeds. Both HTTP requests are subsumed by the logical {es} request span (in blue).
+
+[discrete]
+==== Setup the OpenTelemetry instrumentation
+
+When using the https://opentelemetry.io/docs/languages/python/instrumentation/[manual Python OpenTelemetry instrumentation] or using the https://opentelemetry.io/docs/languages/python/automatic/[OpenTelemetry Python agent], the Python Client's OpenTelemetry instrumentation is enabled by default and uses the global OpenTelemetry SDK with the global tracer provider.
+
+[discrete]
+==== Configuring the OpenTelemetry instrumentation
+
+You can configure the OpenTelemetry instrumentation through environment variables.
+The following configuration options are available.
+
+[discrete]
+[[opentelemetry-config-enable]]
+===== Enable / Disable the OpenTelemetry instrumentation
+
+With this configuration option you can enable (default) or disable the built-in OpenTelemetry instrumentation.
+
+**Default:** `true`
+
+|============
+| Environment Variable | `OTEL_PYTHON_INSTRUMENTATION_ELASTICSEARCH_ENABLED`
+|============
+
+[discrete]
+===== Capture search request bodies
+
+Per default, the built-in OpenTelemetry instrumentation does not capture request bodies due to data privacy considerations. You can use this option to enable capturing of search queries from the request bodies of {es} search requests in case you wish to gather this information regardless. The options are to capture the raw search query or not capture it at all.
+
+**Default:** `omit`
+
+**Valid Options:** `omit`, `raw`
+
+|============
+| Environment Variable | `OTEL_PYTHON_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY`
+|============
+
+[discrete]
+==== Overhead
+
+The OpenTelemetry instrumentation (as any other monitoring approach) may come with a slight overhead on CPU, memory, and/or latency. The overhead may only occur when the instrumentation is enabled (default) and an OpenTelemetry SDK is active in the target application. When the instrumentation is disabled or no OpenTelemetry SDK is active within the target application, monitoring overhead is not expected when using the client.
+
+Even in cases where the instrumentation is enabled and is actively used (by an OpenTelemetry SDK), the overhead is minimal and negligible in the vast majority of cases. In edge cases where there is a noticeable overhead, the <<opentelemetry-config-enable,instrumentation can be explicitly disabled>> to eliminate any potential impact on performance.

docs/guide/images/otel-waterfally-retry.png

@@ -52,7 +52,7 @@ def __init__(
         body_strategy: 'Literal["omit", "raw"]' | None = None,
     ):
         if enabled is None:
-            enabled = os.environ.get(ENABLED_ENV_VAR, "false") != "false"
+            enabled = os.environ.get(ENABLED_ENV_VAR, "true") == "true"
         self.tracer = tracer or _tracer
         self.enabled = enabled and self.tracer is not None
 

docs/guide/integrations.asciidoc

@@ -18,6 +18,7 @@
 
 import pytest
 from elastic_transport.client_utils import DEFAULT
+from elastic_transport import OpenTelemetrySpan
 
 from elasticsearch import AsyncElasticsearch, Elasticsearch
 from elasticsearch._sync.client.utils import USER_AGENT
@@ -137,13 +138,12 @@ def test_options_passed_to_perform_request(self):
         assert call.pop("retry_on_timeout") is DEFAULT
         assert call.pop("retry_on_status") is DEFAULT
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
         }
 
         # Can be overwritten with .options()
@@ -157,13 +157,12 @@ def test_options_passed_to_perform_request(self):
         calls = client.transport.calls
         call = calls[("GET", "/test")][1]
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
             "request_timeout": 1,
             "max_retries": 2,
             "retry_on_status": (404,),
@@ -184,13 +183,12 @@ def test_options_passed_to_perform_request(self):
         calls = client.transport.calls
         call = calls[("GET", "/test")][0]
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
             "request_timeout": 1,
             "max_retries": 2,
             "retry_on_status": (404,),
@@ -213,13 +211,12 @@ async def test_options_passed_to_async_perform_request(self):
         assert call.pop("retry_on_timeout") is DEFAULT
         assert call.pop("retry_on_status") is DEFAULT
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
         }
 
         # Can be overwritten with .options()
@@ -233,13 +230,12 @@ async def test_options_passed_to_async_perform_request(self):
         calls = client.transport.calls
         call = calls[("GET", "/test")][1]
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
             "request_timeout": 1,
             "max_retries": 2,
             "retry_on_status": (404,),
@@ -260,13 +256,12 @@ async def test_options_passed_to_async_perform_request(self):
         calls = client.transport.calls
         call = calls[("GET", "/test")][0]
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
             "request_timeout": 1,
             "max_retries": 2,
             "retry_on_status": (404,),
@@ -397,13 +392,12 @@ def test_options_timeout_parameters(self):
         calls = client.transport.calls
         call = calls[("GET", "/test")][0]
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
             "request_timeout": 1,
             "max_retries": 2,
             "retry_on_status": (404,),
@@ -428,13 +422,12 @@ def test_options_timeout_parameters(self):
         calls = client.transport.calls
         call = calls[("GET", "/test")][0]
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
             "request_timeout": 2,
             "max_retries": 3,
             "retry_on_status": (400,),
@@ -454,13 +447,12 @@ def test_options_timeout_parameters(self):
         assert call.pop("retry_on_timeout") is DEFAULT
         assert call.pop("retry_on_status") is DEFAULT
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
         }
 
         client = Elasticsearch(
@@ -477,13 +469,12 @@ def test_options_timeout_parameters(self):
         calls = client.transport.calls
         call = calls[("GET", "/test")][0]
         assert call.pop("client_meta") is DEFAULT
+        assert isinstance(call.pop("otel_span"), OpenTelemetrySpan)
         assert call == {
             "headers": {
                 "accept": "application/vnd.elasticsearch+json; compatible-with=8",
             },
             "body": None,
-            "endpoint_id": "indices.get",
-            "path_parts": {"index": "test"},
             "request_timeout": 1,
             "max_retries": 2,
             "retry_on_status": (404,),

docs/guide/open-telemetry.asciidoc

@@ -28,7 +28,6 @@
     pass
 
 
-from elasticsearch import JsonSerializer
 from elasticsearch._otel import ENABLED_ENV_VAR, OpenTelemetry
 
 pytestmark = [
@@ -51,7 +50,7 @@ def setup_tracing():
 
 def test_enabled():
     otel = OpenTelemetry()
-    assert otel.enabled == (os.environ.get(ENABLED_ENV_VAR, "false") != "false")
+    assert otel.enabled == (os.environ.get(ENABLED_ENV_VAR, "true") == "true")
 
 
 def test_minimal_span():