chore(telemetry): add integration version to telemetry integrations payload (#6671)

This PR adds version to the APM Telemetry integrations payload. Version
is added by requiring a `get_version` method for all integrations.

## 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/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## 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.
- [x] Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

Author: wconti27

ddtrace/_monkey.py

@@ -165,7 +165,14 @@ def on_import(hook):
             )
         else:
             imported_module.patch()
-            telemetry_writer.add_integration(module, True, PATCH_MODULES.get(module) is True, "")
+            if hasattr(imported_module, "get_versions"):
+                versions = imported_module.get_versions()
+                for name, v in versions.items():
+                    telemetry_writer.add_integration(name, True, PATCH_MODULES.get(module) is True, "", version=v)
+            else:
+                version = imported_module.get_version()
+                telemetry_writer.add_integration(module, True, PATCH_MODULES.get(module) is True, "", version=version)
+
             if hasattr(imported_module, "patch_submodules"):
                 imported_module.patch_submodules(patch_indicator)
 

ddtrace/appsec/iast/_patches/json_tainting.py

@@ -14,6 +14,11 @@
 _DEFAULT_ATTR = "_datadog_json_tainting_patch"
 
 
+def get_version():
+    # type: () -> str
+    return ""
+
+
 def unpatch_iast():
     # type: () -> None
     set_module_unpatched("json", default_attr=_DEFAULT_ATTR)

ddtrace/appsec/iast/taint_sinks/path_traversal.py

@@ -26,6 +26,11 @@ def report(cls, evidence_value=None, sources=None):
         super(PathTraversal, cls).report(evidence_value=evidence_value, sources=sources)
 
 
+def get_version():
+    # type: () -> str
+    return ""
+
+
 def unpatch_iast():
     # type: () -> None
     set_module_unpatched("builtins", default_attr="_datadog_path_traversal_patch")

ddtrace/appsec/iast/taint_sinks/weak_cipher.py

@@ -59,6 +59,11 @@ def unpatch_iast():
     try_unwrap("cryptography.hazmat.primitives.ciphers", "Cipher.encryptor")
 
 
+def get_version():
+    # type: () -> str
+    return ""
+
+
 def patch():
     # type: () -> None
     """Wrap hashing functions.

ddtrace/appsec/iast/taint_sinks/weak_hash.py

@@ -66,6 +66,11 @@ def unpatch_iast():
     try_unwrap("Crypto.Hash.SHA1", "SHA1Hash.hexdigest")
 
 
+def get_version():
+    # type: () -> str
+    return ""
+
+
 def patch():
     # type: () -> None
     """Wrap hashing functions.

ddtrace/contrib/aiobotocore/__init__.py

@@ -47,6 +47,7 @@
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
 
-        __all__ = ["patch"]
+        __all__ = ["patch", "get_version"]

ddtrace/contrib/aiobotocore/patch.py

@@ -26,7 +26,7 @@
 from ..trace_utils import unwrap
 
 
-aiobotocore_version_str = getattr(aiobotocore, "__version__", "0.0.0")
+aiobotocore_version_str = getattr(aiobotocore, "__version__", "")
 AIOBOTOCORE_VERSION = parse_version(aiobotocore_version_str)
 
 if AIOBOTOCORE_VERSION <= (0, 10, 0):
@@ -56,6 +56,11 @@
 )
 
 
+def get_version():
+    # type: () -> str
+    return aiobotocore_version_str
+
+
 def patch():
     if getattr(aiobotocore.client, "_datadog_patch", False):
         return

ddtrace/contrib/aiohttp/__init__.py

@@ -86,11 +86,8 @@ async def home_handler(request):
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
         from .middlewares import trace_app
+        from .patch import get_version
         from .patch import patch
         from .patch import unpatch
 
-        __all__ = [
-            "patch",
-            "unpatch",
-            "trace_app",
-        ]
+        __all__ = ["patch", "unpatch", "trace_app", "get_version"]

ddtrace/contrib/aiohttp/patch.py

@@ -1,5 +1,6 @@
 import os
 
+import aiohttp
 from yarl import URL
 
 from ddtrace import config
@@ -43,6 +44,11 @@
 )
 
 
+def get_version():
+    # type: () -> str
+    return aiohttp.__version__
+
+
 class _WrappedConnectorClass(wrapt.ObjectProxy):
     def __init__(self, obj, pin):
         super().__init__(obj)

ddtrace/contrib/aiohttp_jinja2/__init__.py

@@ -20,7 +20,8 @@
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
         from .patch import unpatch
 
-        __all__ = ["patch", "unpatch"]
+        __all__ = ["patch", "unpatch", "get_version"]

ddtrace/contrib/aiohttp_jinja2/patch.py

@@ -1,3 +1,5 @@
+import aiohttp_jinja2
+
 from ddtrace import Pin
 from ddtrace import config
 from ddtrace.internal.constants import COMPONENT
@@ -15,6 +17,11 @@
 )
 
 
+def get_version():
+    # type: () -> str
+    return getattr(aiohttp_jinja2, "__version__", "")
+
+
 @with_traced_module
 def traced_render_template(aiohttp_jinja2, pin, func, instance, args, kwargs):
     # original signature:

ddtrace/contrib/aiomysql/__init__.py

@@ -43,7 +43,8 @@
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
         from .patch import unpatch
 
-        __all__ = ["patch", "unpatch"]
+        __all__ = ["patch", "unpatch", "get_version"]

ddtrace/contrib/aiomysql/patch.py

@@ -24,6 +24,12 @@
     dict(_default_service=schematize_service_name("mysql")),
 )
 
+
+def get_version():
+    # type: () -> str
+    return getattr(aiomysql, "__version__", "")
+
+
 CONN_ATTR_BY_TAG = {
     net.TARGET_HOST: "host",
     net.TARGET_PORT: "port",

ddtrace/contrib/aiopg/__init__.py

@@ -22,6 +22,7 @@
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
 
-        __all__ = ["patch"]
+        __all__ = ["patch", "get_version"]

ddtrace/contrib/aiopg/patch.py

@@ -12,6 +12,11 @@
 from ddtrace.vendor import wrapt
 
 
+def get_version():
+    # type: () -> str
+    return getattr(aiopg, "__version__", "")
+
+
 def patch():
     """Patch monkey patches psycopg's connection function
     so that the connection's functions are traced.

ddtrace/contrib/aioredis/__init__.py

@@ -57,7 +57,8 @@
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
         from .patch import unpatch
 
-        __all__ = ["patch", "unpatch"]
+        __all__ = ["patch", "unpatch", "get_version"]

ddtrace/contrib/aioredis/patch.py

@@ -40,10 +40,15 @@
     ),
 )
 
-aioredis_version_str = getattr(aioredis, "__version__", "0.0.0")
+aioredis_version_str = getattr(aioredis, "__version__", "")
 aioredis_version = tuple([int(i) for i in aioredis_version_str.split(".")])
 
 
+def get_version():
+    # type: () -> str
+    return aioredis_version_str
+
+
 def patch():
     if getattr(aioredis, "_datadog_patch", False):
         return

ddtrace/contrib/algoliasearch/__init__.py

@@ -30,7 +30,8 @@
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
         from .patch import unpatch
 
-        __all__ = ["patch", "unpatch"]
+        __all__ = ["patch", "unpatch", "get_version"]

ddtrace/contrib/algoliasearch/patch.py

@@ -19,6 +19,7 @@
 APP_NAME = "algoliasearch"
 
 try:
+    VERSION = "0.0.0"
     import algoliasearch
     from algoliasearch.version import VERSION
 
@@ -30,6 +31,11 @@
     algoliasearch_version = (0, 0)
 
 
+def get_version():
+    # type: () -> str
+    return VERSION
+
+
 def patch():
     if algoliasearch_version == (0, 0):
         return

ddtrace/contrib/aredis/__init__.py

@@ -63,6 +63,7 @@ async def example():
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
 
-        __all__ = ["patch"]
+        __all__ = ["patch", "get_version"]

ddtrace/contrib/aredis/patch.py

@@ -23,6 +23,11 @@
 )
 
 
+def get_version():
+    # type: () -> str
+    return getattr(aredis, "__version__", "")
+
+
 def patch():
     """Patch the instrumented methods"""
     if getattr(aredis, "_datadog_patch", False):

ddtrace/contrib/asgi/__init__.py

@@ -69,6 +69,7 @@ def handle_request(scope, send):
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
         from .middleware import TraceMiddleware
+        from .middleware import get_version
         from .middleware import span_from_scope
 
-        __all__ = ["TraceMiddleware", "span_from_scope"]
+        __all__ = ["TraceMiddleware", "span_from_scope", "get_version"]

ddtrace/contrib/asgi/middleware.py

@@ -41,6 +41,11 @@
 ASGI_SPEC_VERSION = "asgi.spec_version"
 
 
+def get_version():
+    # type: () -> str
+    return ""
+
+
 def bytes_to_str(str_or_bytes):
     return str_or_bytes.decode() if isinstance(str_or_bytes, bytes) else str_or_bytes
 

ddtrace/contrib/asyncio/__init__.py

@@ -59,6 +59,7 @@ async def some_work():
         from .helpers import ensure_future
         from .helpers import run_in_executor
         from .helpers import set_call_context
+        from .patch import get_version
         from .patch import patch
 
-        __all__ = ["context_provider", "set_call_context", "ensure_future", "run_in_executor", "patch"]
+        __all__ = ["context_provider", "set_call_context", "ensure_future", "run_in_executor", "patch", "get_version"]

ddtrace/contrib/asyncio/patch.py

@@ -8,6 +8,11 @@
 from .wrappers import wrapped_create_task
 
 
+def get_version():
+    # type: () -> str
+    return ""
+
+
 def patch():
     """Patches current loop `create_task()` method to enable spawned tasks to
     parent to the base task context.

ddtrace/contrib/asyncpg/__init__.py

@@ -50,10 +50,8 @@
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
         from .patch import unpatch
 
-        __all__ = [
-            "patch",
-            "unpatch",
-        ]
+        __all__ = ["patch", "unpatch", "get_version"]

ddtrace/contrib/asyncpg/patch.py

@@ -1,5 +1,7 @@
 from typing import TYPE_CHECKING
 
+import asyncpg
+
 from ddtrace import Pin
 from ddtrace import config
 from ddtrace.internal.constants import COMPONENT
@@ -26,7 +28,6 @@
     from typing import Dict
     from typing import Union
 
-    import asyncpg
     from asyncpg.prepared_stmt import PreparedStatement
 
 
@@ -44,6 +45,11 @@
 log = get_logger(__name__)
 
 
+def get_version():
+    # type: () -> str
+    return getattr(asyncpg, "__version__", "")
+
+
 def _get_connection_tags(conn):
     # type: (asyncpg.Connection) -> Dict[str, str]
     addr = conn._addr

ddtrace/contrib/aws_lambda/__init__.py

@@ -38,8 +38,9 @@
 For additional configuration refer to
 `Instrumenting Python Serverless Applications by Datadog <https://docs.datadoghq.com/serverless/installation/python>`_.
 """
+from .patch import get_version
 from .patch import patch
 from .patch import unpatch
 
 
-__all__ = ["patch", "unpatch"]
+__all__ = ["patch", "unpatch", "get_version"]

ddtrace/contrib/aws_lambda/patch.py

@@ -15,6 +15,11 @@
 from ._cold_start import set_cold_start
 
 
+def get_version():
+    # type: () -> str
+    return ""
+
+
 class DDLambdaLogger:
     """Uses `DDLogger` to log only on cold start invocations."""
 

ddtrace/contrib/boto/__init__.py

@@ -51,6 +51,7 @@
 
 with require_modules(required_modules) as missing_modules:
     if not missing_modules:
+        from .patch import get_version
         from .patch import patch
 
-        __all__ = ["patch"]
+        __all__ = ["patch", "get_version"]