Add OpenTelemetry end-to-end test

Author: pquentin

.buildkite/generatesteps.py

@@ -3,7 +3,7 @@
 import yaml
 
 
-def benchmark_to_steps(python, connection_class):
+def benchmark_to_steps(python, connection_class, nox_session):
     return [
         {
             "group": f":elasticsearch: :python: ES Serverless ({python}/{connection_class})",
@@ -14,6 +14,7 @@ def benchmark_to_steps(python, connection_class):
                     "env": {
                         "PYTHON_VERSION": f"{python}",
                         "PYTHON_CONNECTION_CLASS": f"{connection_class}",
+                        "NOX_SESSION": f"{nox_session}",
                         # For development versions
                         # https://github.com/aio-libs/aiohttp/issues/6600
                         "AIOHTTP_NO_EXTENSIONS": 1,
@@ -55,5 +56,7 @@ def benchmark_to_steps(python, connection_class):
     steps = []
     for python in ["3.9", "3.10", "3.11", "3.12"]:
         for connection_class in ["urllib3", "requests"]:
-            steps.extend(benchmark_to_steps(python, connection_class))
+            steps.extend(benchmark_to_steps(python, connection_class, "test"))
+    steps.extend(benchmark_to_steps("3.9", "urllib3", "test_otel"))
+    steps.extend(benchmark_to_steps("3.12", "urllib3", "test_otel"))
     print(yaml.dump({"steps": steps}, Dumper=yaml.Dumper, sort_keys=False))

.buildkite/run-tests

@@ -51,6 +51,7 @@ echo -e "--- :computer: Environment variables"
 echo -e "ELASTICSEARCH_URL $ELASTICSEARCH_URL"
 echo -e "PYTHON_VERSION $PYTHON_VERSION"
 echo -e "PYTHON_CONNECTION_CLASS $PYTHON_CONNECTION_CLASS"
+echo -e "NOX_SESSION $NOX_SESSION"
 
 echo -e "--- :docker: Build elasticsearch-serverless-python container"
 
@@ -74,4 +75,4 @@ docker run \
   --volume "$(pwd)/junit:/code/elasticsearch-serverless-python/junit" \
   --rm \
   elasticsearch-serverless-python \
-  nox -s "test-$PYTHON_VERSION"
+  nox -s ${NOX_SESSION}-${PYTHON_VERSION}

noxfile.py

@@ -31,14 +31,11 @@
 INSTALL_ENV = {"AIOHTTP_NO_EXTENSIONS": "1"}
 
 
-@nox.session(python=["3.9", "3.10", "3.11", "3.12"])
-def test(session):
-    session.install(".[dev]", env=INSTALL_ENV)
-
+def pytest_argv():
     junit_xml = os.path.join(
         SOURCE_DIR, "junit", "elasticsearch-serverless-python-junit.xml"
     )
-    pytest_argv = [
+    return [
         "pytest",
         "--cov-report=term-missing",
         "--cov=elasticsearch_serverless",
@@ -47,9 +44,23 @@ def test(session):
         "--log-level=debug",
         "-vv",
         "--cache-clear",
-        *(session.posargs),
     ]
-    session.run(*pytest_argv)
+
+
+@nox.session(python=["3.9", "3.10", "3.11", "3.12"])
+def test(session):
+    session.install(".[dev]", env=INSTALL_ENV)
+
+    session.run(*pytest_argv(), *(session.posargs))
+
+
+@nox.session(python=["3.9", "3.12"])
+def test_otel(session):
+    session.install(".[dev]", env=INSTALL_ENV)
+    session.install("opentelemetry-api", "opentelemetry-sdk")
+
+    argv = pytest_argv() + ["-m", "otel"]
+    session.run(*argv, *(session.posargs), env={"TEST_WITH_OTEL": "1"})
 
 
 @nox.session()

pyproject.toml

@@ -99,7 +99,8 @@ packages = ["elasticsearch_serverless"]
 
 [tool.pytest.ini_options]
 junit_family = "legacy"
-xfail_strict=true
+xfail_strict = true
+markers = "otel"
 
 [tool.isort]
 profile = "black"

test_elasticsearch_serverless/test_server/test_otel.py

@@ -0,0 +1,61 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+import os
+
+import pytest
+
+try:
+    from opentelemetry import trace
+    from opentelemetry.sdk.trace import TracerProvider, export
+    from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
+        InMemorySpanExporter,
+    )
+except ModuleNotFoundError:
+    pass
+
+pytestmark = [
+    pytest.mark.skipif(
+        "TEST_WITH_OTEL" not in os.environ, reason="TEST_WITH_OTEL is not set"
+    ),
+    pytest.mark.otel,
+]
+
+
+def test_otel_end_to_end(monkeypatch, sync_client):
+    # Sets the global default tracer provider
+    tracer_provider = TracerProvider()
+    memory_exporter = InMemorySpanExporter()
+    span_processor = export.SimpleSpanProcessor(memory_exporter)
+    tracer_provider.add_span_processor(span_processor)
+    trace.set_tracer_provider(tracer_provider)
+
+    resp = sync_client.search(index="logs-*", query={"match_all": {}})
+    assert resp.meta.status == 200
+
+    spans = memory_exporter.get_finished_spans()
+    assert len(spans) == 1
+    assert spans[0].name == "search"
+    expected_attributes = {
+        "http.request.method": "POST",
+        "db.system": "elasticsearch",
+        "db.operation": "search",
+        "db.elasticsearch.path_parts.index": "logs-*",
+    }
+    # Assert expected atttributes are here, but allow other attributes too
+    # to make this test robust to elastic-transport changes
+    assert expected_attributes.items() <= spans[0].attributes.items()