feat(otel): move to plugins, fix bugs #4468 and #4466, add upstream parity

Author: cofin

docs/conf.py

@@ -117,6 +117,9 @@
     (PY_METH, "litestar.typing.ParsedType.is_subclass_of"),
     (PY_METH, "type_engine"),
     # type vars and aliases / intentionally undocumented
+    (PY_CLASS, "ClientRequestHookHandler"),
+    (PY_CLASS, "ClientResponseHookHandler"),
+    (PY_CLASS, "ServerRequestHookHandler"),
     (PY_CLASS, "AnyIOBackend"),
     (PY_CLASS, "BaseSessionBackendT"),
     (PY_CLASS, "C"),

docs/getting-started.rst

@@ -38,7 +38,7 @@ Installation
     :doc:`Prometheus Instrumentation </usage/metrics/prometheus>`
         :code:`pip install 'litestar[prometheus]'`
 
-    :doc:`Open Telemetry Instrumentation </usage/metrics/open-telemetry>`
+    :doc:`OpenTelemetry Instrumentation </usage/metrics/opentelemetry>`
         :code:`pip install 'litestar[opentelemetry]'`
 
     :doc:`SQLAlchemy </usage/databases/sqlalchemy/index>` (via `Advanced-Alchemy <https://advanced-alchemy.litestar.dev/latest/>`_)

docs/reference/contrib/index.rst

@@ -6,4 +6,3 @@ contrib
 
     jinja
     mako
-    opentelemetry

docs/reference/contrib/opentelemetry.rst

@@ -12,6 +12,7 @@ plugins
     attrs
     flash_messages
     htmx
+    opentelemetry
     problem_details
     prometheus
     pydantic

docs/reference/plugins/index.rst

@@ -0,0 +1,8 @@
+opentelemetry
+=============
+
+.. automodule:: litestar.plugins.opentelemetry
+    :members:
+
+.. automodule:: litestar.plugins.opentelemetry.config
+    :members:

docs/reference/plugins/opentelemetry.rst

@@ -4,5 +4,5 @@ Metrics
 .. toctree::
     :titlesonly:
 
-    open-telemetry
+    opentelemetry
     prometheus

docs/usage/metrics/index.rst

@@ -1,7 +1,7 @@
 OpenTelemetry
 =============
 
-Litestar includes optional OpenTelemetry instrumentation that is exported from ``litestar.contrib.opentelemetry``. To use
+Litestar includes optional OpenTelemetry instrumentation that is exported from ``litestar.plugins.opentelemetry``. To use
 this package, you should first install the required dependencies:
 
 .. code-block:: bash
@@ -16,13 +16,13 @@ this package, you should first install the required dependencies:
     pip install 'litestar[opentelemetry]'
 
 Once these requirements are satisfied, you can instrument your Litestar application by creating an instance
-of :class:`OpenTelemetryConfig <litestar.contrib.opentelemetry.OpenTelemetryConfig>` and passing the middleware it creates to
+of :class:`OpenTelemetryConfig <litestar.plugins.opentelemetry.OpenTelemetryConfig>` and passing the middleware it creates to
 the Litestar constructor:
 
 .. code-block:: python
 
    from litestar import Litestar
-   from litestar.contrib.opentelemetry import OpenTelemetryConfig, OpenTelemetryPlugin
+   from litestar.plugins.opentelemetry import OpenTelemetryConfig, OpenTelemetryPlugin
 
    open_telemetry_config = OpenTelemetryConfig()
 
@@ -33,4 +33,4 @@ exporter to use these (see the
 `OpenTelemetry Exporter docs <https://opentelemetry.io/docs/instrumentation/python/exporters/>`_ for further details).
 
 You can also pass con figuration to the ``OpenTelemetryConfig`` telling it which providers to use. Consult
-:class:`reference docs <litestar.contrib.opentelemetry.OpenTelemetryConfig>` regarding the configuration options you can use.
+:class:`reference docs <litestar.plugins.opentelemetry.OpenTelemetryConfig>` regarding the configuration options you can use.

docs/usage/metrics/open-telemetry.rst docs/usage/metrics/opentelemetry.rstdocs/usage/metrics/open-telemetry.rst renamed to docs/usage/metrics/opentelemetry.rst

@@ -62,12 +62,12 @@
     from litestar.config.compression import CompressionConfig
     from litestar.config.cors import CORSConfig
     from litestar.config.csrf import CSRFConfig
-    from litestar.contrib.opentelemetry import OpenTelemetryPlugin
     from litestar.datastructures import CacheControlHeader, ETag
     from litestar.dto import AbstractDTO
     from litestar.events.listener import EventListener
     from litestar.openapi.spec import SecurityRequirement
     from litestar.openapi.spec.open_api import OpenAPI
+    from litestar.plugins.opentelemetry import OpenTelemetryPlugin
     from litestar.response import Response
     from litestar.stores.base import Store
     from litestar.types import (
@@ -493,7 +493,7 @@ def _patch_opentelemetry_middleware(config: AppConfig) -> AppConfig:
         # workaround to support otel middleware priority. Should be replaced by regular
         # middleware priorities once available
         try:
-            from litestar.contrib.opentelemetry import OpenTelemetryPlugin
+            from litestar.plugins.opentelemetry import OpenTelemetryPlugin
 
             if not any(isinstance(p, OpenTelemetryPlugin) for p in config.plugins):
                 config.middleware, otel_middleware = OpenTelemetryPlugin._pop_otel_middleware(config.middleware)