feat(AGE-298) : enable auto instrumentation without middleware-run

Author: mw-advait

dev-requirements.txt

@@ -28,7 +28,7 @@ importlib-metadata==8.4.0
     # via
     #   opentelemetry-api
     #   opentelemetry-instrumentation-flask
-opentelemetry-api==1.27.0
+opentelemetry-api==1.36.0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-exporter-otlp-proto-grpc
@@ -88,11 +88,11 @@ opentelemetry-api==1.27.0
     #   opentelemetry-resourcedetector-gcp
     #   opentelemetry-sdk
     #   opentelemetry-semantic-conventions
-opentelemetry-exporter-otlp-proto-common==1.27.0
+opentelemetry-exporter-otlp-proto-common==1.36.0
     # via opentelemetry-exporter-otlp-proto-grpc
-opentelemetry-exporter-otlp-proto-grpc==1.27.0
+opentelemetry-exporter-otlp-proto-grpc==1.36.0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation==0.48b0
+opentelemetry-instrumentation==0.57b0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-instrumentation-aio-pika
@@ -141,36 +141,44 @@ opentelemetry-instrumentation==0.48b0
     #   opentelemetry-instrumentation-urllib
     #   opentelemetry-instrumentation-urllib3
     #   opentelemetry-instrumentation-wsgi
-opentelemetry-instrumentation-aio-pika==0.48b0
+opentelemetry-instrumentation-aio-pika==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-aiohttp-client==0.48b0
+opentelemetry-instrumentation-aiohttp-client==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-aiohttp-server==0.48b0
+opentelemetry-instrumentation-aiohttp-server==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-aiopg==0.48b0
+opentelemetry-instrumentation-aiokafka==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-asgi==0.48b0
+opentelemetry-instrumentation-aiopg==0.57b0
+    # via middleware-io (pyproject.toml)
+opentelemetry-instrumentation-asgi==0.57b0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-instrumentation-fastapi
     #   opentelemetry-instrumentation-starlette
-opentelemetry-instrumentation-asyncio==0.48b0
+opentelemetry-instrumentation-asyncclick==0.57b0
+    # via middleware-io (pyproject.toml)
+opentelemetry-instrumentation-asyncio==0.57b0
+    # via middleware-io (pyproject.toml)
+opentelemetry-instrumentation-asyncpg==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-asyncpg==0.48b0
+opentelemetry-instrumentation-aws-lambda==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-boto==0.48b0
+opentelemetry-instrumentation-boto==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-boto3sqs==0.48b0
+opentelemetry-instrumentation-boto3sqs==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-botocore==0.48b0
+opentelemetry-instrumentation-botocore==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-cassandra==0.48b0
+opentelemetry-instrumentation-cassandra==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-celery==0.48b0
+opentelemetry-instrumentation-celery==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-confluent-kafka==0.48b0
+opentelemetry-instrumentation-click==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-dbapi==0.48b0
+opentelemetry-instrumentation-confluent-kafka==0.57b0
+    # via middleware-io (pyproject.toml)
+opentelemetry-instrumentation-dbapi==0.57b0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-instrumentation-aiopg
@@ -180,90 +188,92 @@ opentelemetry-instrumentation-dbapi==0.48b0
     #   opentelemetry-instrumentation-psycopg2
     #   opentelemetry-instrumentation-pymysql
     #   opentelemetry-instrumentation-sqlite3
-opentelemetry-instrumentation-django==0.48b0
+opentelemetry-instrumentation-django==0.57b0
+    # via middleware-io (pyproject.toml)
+opentelemetry-instrumentation-elasticsearch==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-elasticsearch==0.48b0
+opentelemetry-instrumentation-falcon==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-falcon==0.48b0
+opentelemetry-instrumentation-fastapi==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-fastapi==0.48b0
+opentelemetry-instrumentation-flask==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-flask==0.48b0
+opentelemetry-instrumentation-grpc==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-grpc==0.48b0
+opentelemetry-instrumentation-httpx==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-httpx==0.48b0
+opentelemetry-instrumentation-jinja2==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-jinja2==0.48b0
+opentelemetry-instrumentation-kafka-python==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-kafka-python==0.48b0
+opentelemetry-instrumentation-logging==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-logging==0.48b0
+opentelemetry-instrumentation-mysql==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-mysql==0.48b0
+opentelemetry-instrumentation-mysqlclient==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-mysqlclient==0.48b0
+opentelemetry-instrumentation-pika==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-pika==0.48b0
+opentelemetry-instrumentation-psycopg==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-psycopg==0.48b0
+opentelemetry-instrumentation-psycopg2==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-psycopg2==0.48b0
+opentelemetry-instrumentation-pymemcache==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-pymemcache==0.48b0
+opentelemetry-instrumentation-pymongo==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-pymongo==0.48b0
+opentelemetry-instrumentation-pymysql==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-pymysql==0.48b0
+opentelemetry-instrumentation-pymssql==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-pyramid==0.48b0
+opentelemetry-instrumentation-pyramid==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-redis==0.48b0
+opentelemetry-instrumentation-redis==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-remoulade==0.48b0
+opentelemetry-instrumentation-remoulade==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-requests==0.48b0
+opentelemetry-instrumentation-requests==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-sqlalchemy==0.48b0
+opentelemetry-instrumentation-sqlalchemy==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-sqlite3==0.48b0
+opentelemetry-instrumentation-sqlite3==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-starlette==0.48b0
+opentelemetry-instrumentation-starlette==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-system-metrics==0.48b0
+opentelemetry-instrumentation-system-metrics==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-threading==0.48b0
+opentelemetry-instrumentation-threading==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-tornado==0.48b0
+opentelemetry-instrumentation-tornado==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-tortoiseorm==0.48b0
+opentelemetry-instrumentation-tortoiseorm==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-urllib==0.48b0
+opentelemetry-instrumentation-urllib==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-urllib3==0.48b0
+opentelemetry-instrumentation-urllib3==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-instrumentation-wsgi==0.48b0
+opentelemetry-instrumentation-wsgi==0.57b0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-instrumentation-django
     #   opentelemetry-instrumentation-falcon
     #   opentelemetry-instrumentation-flask
     #   opentelemetry-instrumentation-pyramid
-opentelemetry-processor-baggage==0.48b0
+opentelemetry-processor-baggage==0.57b0
     # via middleware-io (pyproject.toml)
 opentelemetry-propagator-aws-xray==1.0.2
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-instrumentation-botocore
-opentelemetry-propagator-b3==1.27.0
+opentelemetry-propagator-b3==1.36.0
     # via middleware-io (pyproject.toml)
-opentelemetry-propagator-gcp==1.7.0
+opentelemetry-propagator-gcp==1.9.0
     # via middleware-io (pyproject.toml)
-opentelemetry-propagator-jaeger==1.27.0
+opentelemetry-propagator-jaeger==1.36.0
     # via middleware-io (pyproject.toml)
-opentelemetry-propagator-ot-trace==0.48b0
+opentelemetry-propagator-ot-trace==0.57b0
     # via middleware-io (pyproject.toml)
-opentelemetry-proto==1.27.0
+opentelemetry-proto==1.36.0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-exporter-otlp-proto-common
@@ -272,9 +282,9 @@ opentelemetry-resource-detector-azure==0.1.5
     # via middleware-io (pyproject.toml)
 opentelemetry-resourcedetector-docker==0.4.0
     # via middleware-io (pyproject.toml)
-opentelemetry-resourcedetector-gcp==1.7.0a0
+opentelemetry-resourcedetector-gcp==1.9.0a0
     # via middleware-io (pyproject.toml)
-opentelemetry-sdk==1.27.0
+opentelemetry-sdk==1.36.0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-exporter-otlp-proto-grpc
@@ -286,7 +296,7 @@ opentelemetry-sdk==1.27.0
     #   opentelemetry-sdk-extension-aws
 opentelemetry-sdk-extension-aws==2.0.2
     # via middleware-io (pyproject.toml)
-opentelemetry-semantic-conventions==0.48b0
+opentelemetry-semantic-conventions==0.57b0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-instrumentation-aiohttp-client
@@ -323,7 +333,7 @@ opentelemetry-semantic-conventions==0.48b0
     #   opentelemetry-instrumentation-wsgi
     #   opentelemetry-resourcedetector-docker
     #   opentelemetry-sdk
-opentelemetry-util-http==0.48b0
+opentelemetry-util-http==0.57b0
     # via
     #   middleware-io (pyproject.toml)
     #   opentelemetry-instrumentation-aiohttp-client
@@ -347,7 +357,7 @@ packaging==24.2
     #   opentelemetry-instrumentation-flask
     #   opentelemetry-instrumentation-pika
     #   opentelemetry-instrumentation-sqlalchemy
-protobuf==4.25.5
+protobuf==5.26.1
     # via
     #   googleapis-common-protos
     #   opentelemetry-proto

middleware/__init__.py

@@ -1,4 +1,4 @@
-from middleware.distro import mw_tracker, custom_record_exception_wrapper, record_exception
+from middleware.distro import mw_tracker, mw_tracker_internal, custom_record_exception_wrapper, record_exception
 from opentelemetry.sdk.trace import Span
 from middleware.options import (
     MWOptions,
@@ -15,8 +15,9 @@
 )
 
 __all__ = [
-    "mw_tracker",
+    "mw_tracker_internal",
     "record_exception",
+    "mw_tracker",
     "MWOptions",
     "DETECT_AWS_BEANSTALK",
     "DETECT_AWS_EC2",

middleware/distro.py

@@ -5,6 +5,8 @@
 import sys
 from logging import getLogger
 from typing import Optional
+
+import pkg_resources
 from opentelemetry.instrumentation.distro import BaseDistro
 from middleware.metrics import create_meter_provider
 from middleware.options import MWOptions, parse_bool
@@ -29,7 +31,7 @@
 )
 
 
-def mw_tracker(
+def mw_tracker_internal(
     options: Optional[MWOptions] = None,
 ):
     """
@@ -246,7 +248,51 @@ def custom_record_exception(span: Span, exc: Exception):
     )
 
 
+def mw_tracker(options: Optional[MWOptions] = None):
+    """
+    Configures the OpenTelemetry SDK to send telemetry to middleware.
 
+    Args:
+        options (MWOptions, optional): the MWOptions used to
+        configure the the SDK. These options can be set either as parameters
+        to this function or through environment variables
+
+    Example
+    --------
+    >>> from middleware import mw_tracker, MWOptions, record_exception, DETECT_AWS_EC2
+    >>> mw_tracker(
+    >>>     MWOptions(
+    >>>         access_token="whkvkobudfitutobptgonaezuxpjjypnejbb",
+    >>>         target="https://myapp.middleware.io:443",
+    >>>         console_exporter=True,
+    >>>         debug_log_file=True,
+    >>>         service_name="MyPythonServer",
+    >>>         otel_propagators = "b3,tracecontext",
+    >>>         custom_resource_attributes="call_id=12345678, request_id=987654321",
+    >>>         detectors=[DETECT_AWS_EC2]
+    >>>     )
+    >>> )
+
+    """
+    
+    # 1. Load the distro
+    for entry_point in pkg_resources.iter_entry_points("opentelemetry_distro"):
+        print(f"Entrypoint distro :", entry_point)
+        distro_class = entry_point.load()
+        if issubclass(distro_class, BaseDistro):
+            distro = distro_class()
+            distro._configure(options=options)
+            break
+
+    # 2. Auto-instrument all registered instrumentors
+    for entry_point in pkg_resources.iter_entry_points("opentelemetry_instrumentor"):
+        print(f"Entrypoint instrumentor :", entry_point)
+        try:
+            instrumentor_class = entry_point.load()
+            instrumentor = instrumentor_class()
+            instrumentor.instrument()
+        except Exception as e:
+            print(f"Failed to instrument {instrumentor_class}: {e}")
 
 # pylint: disable=too-few-public-methods
 class MiddlewareDistro(BaseDistro):
@@ -264,8 +310,13 @@ class MiddlewareDistro(BaseDistro):
     distro = "middleware.opentelemetry.distro:MiddlewareDistro"
     """
 
-    def _configure(self, **kwargs):
+    def _configure(self, options: Optional[MWOptions] = None, **kwargs):
         global isTracker, distro_called
         distro_called = True
         if not isTracker:
-            mw_tracker()
+            mw_tracker_internal()
+        elif isTracker and options is not None:
+            mw_tracker_internal(options=options)
+    
+    def instrument(self, **kwargs):
+        print("MiddlewareDistro instrument called")