fix(elasticsearch): elasticsearch8 circular import error [backport #5753 to 1.12] (#5791)

Backport of #5753 to 1.12

Currently if using >= elasticsearch 8 the tracer will throw an error as
it tries to patch, since we haven't added support for this version.

This fix version guards patching, so users don't have to disable the
integration manually.

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/contributing.html#Release-Note-Guidelines)
are followed.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] PR description includes explicit acknowledgement/acceptance of the
performance implications of this PR as reported in the benchmarks PR
comment.

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.

Co-authored-by: Brett Langdon <[email protected]>

Author: ZStriker19

.riot/requirements/131d266.txt

@@ -0,0 +1,27 @@
+#
+# This file is autogenerated by pip-compile with Python 3.7
+# by the following command:
+#
+#    pip-compile --no-annotate --resolver=backtracking .riot/requirements/131d266.in
+#
+attrs==23.1.0
+certifi==2022.12.7
+coverage[toml]==7.2.5
+elastic-transport==8.4.0
+elasticsearch8==8.7.0
+exceptiongroup==1.1.1
+hypothesis==6.45.0
+importlib-metadata==6.6.0
+iniconfig==2.0.0
+mock==5.0.2
+opentracing==2.4.0
+packaging==23.1
+pluggy==1.0.0
+pytest==7.3.1
+pytest-cov==4.0.0
+pytest-mock==3.10.0
+sortedcontainers==2.4.0
+tomli==2.0.1
+typing-extensions==4.5.0
+urllib3==1.26.15
+zipp==3.15.0

.riot/requirements/15b846e.txt

@@ -0,0 +1,24 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile --no-annotate --resolver=backtracking .riot/requirements/15b846e.in
+#
+attrs==23.1.0
+certifi==2022.12.7
+coverage[toml]==7.2.5
+elastic-transport==8.4.0
+elasticsearch8==8.7.0
+exceptiongroup==1.1.1
+hypothesis==6.45.0
+iniconfig==2.0.0
+mock==5.0.2
+opentracing==2.4.0
+packaging==23.1
+pluggy==1.0.0
+pytest==7.3.1
+pytest-cov==4.0.0
+pytest-mock==3.10.0
+sortedcontainers==2.4.0
+tomli==2.0.1
+urllib3==1.26.15

.riot/requirements/165f0ba.txt

@@ -0,0 +1,24 @@
+#
+# This file is autogenerated by pip-compile with Python 3.8
+# by the following command:
+#
+#    pip-compile --no-annotate --resolver=backtracking .riot/requirements/165f0ba.in
+#
+attrs==23.1.0
+certifi==2022.12.7
+coverage[toml]==7.2.5
+elastic-transport==8.4.0
+elasticsearch8==8.7.0
+exceptiongroup==1.1.1
+hypothesis==6.45.0
+iniconfig==2.0.0
+mock==5.0.2
+opentracing==2.4.0
+packaging==23.1
+pluggy==1.0.0
+pytest==7.3.1
+pytest-cov==4.0.0
+pytest-mock==3.10.0
+sortedcontainers==2.4.0
+tomli==2.0.1
+urllib3==1.26.15

.riot/requirements/1c63df9.txt

@@ -0,0 +1,29 @@
+#
+# This file is autogenerated by pip-compile with python 3.6
+# To update, run:
+#
+#    pip-compile --no-annotate .riot/requirements/1c63df9.in
+#
+attrs==22.2.0
+certifi==2022.12.7
+coverage[toml]==6.2
+dataclasses==0.8
+elastic-transport==8.4.0
+elasticsearch8==8.7.0
+hypothesis==6.31.6
+importlib-metadata==4.8.3
+iniconfig==1.1.1
+mock==5.0.2
+opentracing==2.4.0
+packaging==21.3
+pluggy==1.0.0
+py==1.11.0
+pyparsing==3.0.9
+pytest==7.0.1
+pytest-cov==4.0.0
+pytest-mock==3.6.1
+sortedcontainers==2.4.0
+tomli==1.2.3
+typing-extensions==4.1.1
+urllib3==1.26.15
+zipp==3.6.0

.riot/requirements/84c2760.txt

@@ -0,0 +1,22 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile --no-annotate --resolver=backtracking .riot/requirements/84c2760.in
+#
+attrs==23.1.0
+certifi==2022.12.7
+coverage[toml]==7.2.5
+elastic-transport==8.4.0
+elasticsearch8==8.7.0
+hypothesis==6.45.0
+iniconfig==2.0.0
+mock==5.0.2
+opentracing==2.4.0
+packaging==23.1
+pluggy==1.0.0
+pytest==7.3.1
+pytest-cov==4.0.0
+pytest-mock==3.10.0
+sortedcontainers==2.4.0
+urllib3==1.26.15

.riot/requirements/a362729.txt

@@ -0,0 +1,24 @@
+#
+# This file is autogenerated by pip-compile with Python 3.9
+# by the following command:
+#
+#    pip-compile --no-annotate --resolver=backtracking .riot/requirements/a362729.in
+#
+attrs==23.1.0
+certifi==2022.12.7
+coverage[toml]==7.2.5
+elastic-transport==8.4.0
+elasticsearch8==8.7.0
+exceptiongroup==1.1.1
+hypothesis==6.45.0
+iniconfig==2.0.0
+mock==5.0.2
+opentracing==2.4.0
+packaging==23.1
+pluggy==1.0.0
+pytest==7.3.1
+pytest-cov==4.0.0
+pytest-mock==3.10.0
+sortedcontainers==2.4.0
+tomli==2.0.1
+urllib3==1.26.15

ddtrace/contrib/elasticsearch/patch.py

@@ -4,6 +4,7 @@
 from ddtrace._tracing import _limits
 from ddtrace.contrib.trace_utils import ext_service
 from ddtrace.internal.constants import COMPONENT
+from ddtrace.internal.logger import get_logger
 from ddtrace.vendor.wrapt import wrap_function_wrapper as _w
 
 from ...constants import ANALYTICS_SAMPLE_RATE_KEY
@@ -19,6 +20,8 @@
 from .quantize import quantize
 
 
+log = get_logger(__name__)
+
 config._add(
     "elasticsearch",
     {
@@ -44,14 +47,19 @@ def _es_modules():
             pass
 
 
+def get_version(elasticsearch):
+    return getattr(elasticsearch, "__version__", (0, 0, 0))
+
+
 # NB: We are patching the default elasticsearch.transport module
 def patch():
     for elasticsearch in _es_modules():
         _patch(elasticsearch)
 
 
 def _patch(elasticsearch):
-    if getattr(elasticsearch, "_datadog_patch", False):
+    # elasticsearch 8 is not yet supported
+    if getattr(elasticsearch, "_datadog_patch", False) or get_version(elasticsearch) >= (8, 0, 0):
         return
     setattr(elasticsearch, "_datadog_patch", True)
     _w(elasticsearch.transport, "Transport.perform_request", _get_perform_request(elasticsearch))

releasenotes/notes/version_guard_es8-7b11c3f2f6c76948.yaml

@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    elasticsearch: This fix resolves an issue where the tracer would throw an error when patching
+    unsupported versions of elasticsearch (> 8.0). Patching is now skipped if an unsupported version is detected.

riotfile.py

@@ -909,6 +909,18 @@ def select_pys(min_version=MIN_PYTHON_VERSION, max_version=MAX_PYTHON_VERSION):
                 ),
             ],
         ),
+        Venv(
+            name="elasticsearch8-patch",
+            command="pytest {cmdargs} tests/contrib/elasticsearch/test_es8_patch.py",
+            venvs=[
+                Venv(
+                    pys=select_pys(min_version="3.6"),
+                    pkgs={
+                        "elasticsearch8": [latest],
+                    },
+                ),
+            ],
+        ),
         Venv(
             name="elasticsearch-opensearch",
             # avoid running tests in ElasticsearchPatchTest, only run tests with OpenSearchPatchTest configurations

tests/contrib/elasticsearch/test_es8_patch.py

@@ -0,0 +1,9 @@
+from ddtrace.contrib.elasticsearch.patch import patch
+from tests.utils import TracerTestCase
+
+
+class ElasticsearchPatchTest(TracerTestCase):
+    def test_patch(self):
+        # This is to stop crashing applications if ES8 is used
+        # If it doesn't error, we are good.
+        patch()