summaryrefslogtreecommitdiff
path: root/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry
diff options
context:
space:
mode:
authorcyfraeviolae <cyfraeviolae>2024-04-03 03:17:55 -0400
committercyfraeviolae <cyfraeviolae>2024-04-03 03:17:55 -0400
commit12cf076118570eebbff08c6b3090e0d4798447a1 (patch)
tree3ba25e17e3c3a5e82316558ba3864b955919ff72 /venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry
parentc45662ff3923b34614ddcc8feb9195541166dcc5 (diff)
no venv
Diffstat (limited to 'venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry')
-rw-r--r--venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__init__.py4
-rw-r--r--venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/__init__.cpython-311.pycbin395 -> 0 bytes
-rw-r--r--venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/_utils.cpython-311.pycbin1365 -> 0 bytes
-rw-r--r--venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/config.cpython-311.pycbin4141 -> 0 bytes
-rw-r--r--venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/middleware.cpython-311.pycbin3440 -> 0 bytes
-rw-r--r--venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/_utils.py31
-rw-r--r--venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/config.py102
-rw-r--r--venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/middleware.py60
8 files changed, 0 insertions, 197 deletions
diff --git a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__init__.py b/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__init__.py
deleted file mode 100644
index 3f93611..0000000
--- a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__init__.py
+++ /dev/null
@@ -1,4 +0,0 @@
-from .config import OpenTelemetryConfig
-from .middleware import OpenTelemetryInstrumentationMiddleware
-
-__all__ = ("OpenTelemetryConfig", "OpenTelemetryInstrumentationMiddleware")
diff --git a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/__init__.cpython-311.pyc
deleted file mode 100644
index 799a915..0000000
--- a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/__init__.cpython-311.pyc
+++ /dev/null
Binary files differ
diff --git a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/_utils.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/_utils.cpython-311.pyc
deleted file mode 100644
index c401f9c..0000000
--- a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/_utils.cpython-311.pyc
+++ /dev/null
Binary files differ
diff --git a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/config.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/config.cpython-311.pyc
deleted file mode 100644
index b41bc7e..0000000
--- a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/config.cpython-311.pyc
+++ /dev/null
Binary files differ
diff --git a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/middleware.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/middleware.cpython-311.pyc
deleted file mode 100644
index 291b510..0000000
--- a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/__pycache__/middleware.cpython-311.pyc
+++ /dev/null
Binary files differ
diff --git a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/_utils.py b/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/_utils.py
deleted file mode 100644
index 0ba7cb9..0000000
--- a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/_utils.py
+++ /dev/null
@@ -1,31 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, Any
-
-from litestar.exceptions import MissingDependencyException
-
-__all__ = ("get_route_details_from_scope",)
-
-
-try:
- import opentelemetry # noqa: F401
-except ImportError as e:
- raise MissingDependencyException("opentelemetry") from e
-
-from opentelemetry.semconv.trace import SpanAttributes
-
-if TYPE_CHECKING:
- from litestar.types import Scope
-
-
-def get_route_details_from_scope(scope: Scope) -> tuple[str, dict[Any, str]]:
- """Retrieve the span name and attributes from the ASGI scope.
-
- Args:
- scope: The ASGI scope instance.
-
- Returns:
- A tuple of the span name and a dict of attrs.
- """
- route_handler_fn_name = scope["route_handler"].handler_name
- return route_handler_fn_name, {SpanAttributes.HTTP_ROUTE: route_handler_fn_name}
diff --git a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/config.py b/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/config.py
deleted file mode 100644
index c0cce8a..0000000
--- a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/config.py
+++ /dev/null
@@ -1,102 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass, field
-from typing import TYPE_CHECKING, Any, Callable
-
-from litestar.contrib.opentelemetry._utils import get_route_details_from_scope
-from litestar.contrib.opentelemetry.middleware import (
- OpenTelemetryInstrumentationMiddleware,
-)
-from litestar.exceptions import MissingDependencyException
-from litestar.middleware.base import DefineMiddleware
-
-__all__ = ("OpenTelemetryConfig",)
-
-
-try:
- import opentelemetry # noqa: F401
-except ImportError as e:
- raise MissingDependencyException("opentelemetry") from e
-
-
-from opentelemetry.trace import Span, TracerProvider # pyright: ignore
-
-if TYPE_CHECKING:
- from opentelemetry.metrics import Meter, MeterProvider
-
- from litestar.types import Scope, Scopes
-
-OpenTelemetryHookHandler = Callable[[Span, dict], None]
-
-
-@dataclass
-class OpenTelemetryConfig:
- """Configuration class for the OpenTelemetry middleware.
-
- Consult the [OpenTelemetry ASGI documentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/asgi/asgi.html) for more info about the configuration options.
- """
-
- scope_span_details_extractor: Callable[[Scope], tuple[str, dict[str, Any]]] = field(
- default=get_route_details_from_scope
- )
- """Callback which should return a string and a tuple, representing the desired default span name and a dictionary
- with any additional span attributes to set.
- """
- server_request_hook_handler: OpenTelemetryHookHandler | None = field(default=None)
- """Optional callback which is called with the server span and ASGI scope object for every incoming request."""
- client_request_hook_handler: OpenTelemetryHookHandler | None = field(default=None)
- """Optional callback which is called with the internal span and an ASGI scope which is sent as a dictionary for when
- the method receive is called.
- """
- client_response_hook_handler: OpenTelemetryHookHandler | None = field(default=None)
- """Optional callback which is called with the internal span and an ASGI event which is sent as a dictionary for when
- the method send is called.
- """
- meter_provider: MeterProvider | None = field(default=None)
- """Optional meter provider to use.
-
- If omitted the current globally configured one is used.
- """
- tracer_provider: TracerProvider | None = field(default=None)
- """Optional tracer provider to use.
-
- If omitted the current globally configured one is used.
- """
- meter: Meter | None = field(default=None)
- """Optional meter to use.
-
- If omitted the provided meter provider or the global one will be used.
- """
- exclude: str | list[str] | None = field(default=None)
- """A pattern or list of patterns to skip in the Allowed Hosts middleware."""
- exclude_opt_key: str | None = field(default=None)
- """An identifier to use on routes to disable hosts check for a particular route."""
- exclude_urls_env_key: str = "LITESTAR"
- """Key to use when checking whether a list of excluded urls is passed via ENV.
-
- OpenTelemetry supports excluding urls by passing an env in the format '{exclude_urls_env_key}_EXCLUDED_URLS'. With
- the default being ``LITESTAR_EXCLUDED_URLS``.
- """
- scopes: Scopes | None = field(default=None)
- """ASGI scopes processed by the middleware, if None both ``http`` and ``websocket`` will be processed."""
- middleware_class: type[OpenTelemetryInstrumentationMiddleware] = field(
- default=OpenTelemetryInstrumentationMiddleware
- )
- """The middleware class to use.
-
- Should be a subclass of OpenTelemetry
- InstrumentationMiddleware][litestar.contrib.opentelemetry.OpenTelemetryInstrumentationMiddleware].
- """
-
- @property
- def middleware(self) -> DefineMiddleware:
- """Create an instance of :class:`DefineMiddleware <litestar.middleware.base.DefineMiddleware>` that wraps with.
-
- [OpenTelemetry
- InstrumentationMiddleware][litestar.contrib.opentelemetry.OpenTelemetryInstrumentationMiddleware] or a subclass
- of this middleware.
-
- Returns:
- An instance of ``DefineMiddleware``.
- """
- return DefineMiddleware(self.middleware_class, config=self)
diff --git a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/middleware.py b/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/middleware.py
deleted file mode 100644
index 762bae9..0000000
--- a/venv/lib/python3.11/site-packages/litestar/contrib/opentelemetry/middleware.py
+++ /dev/null
@@ -1,60 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-from litestar.exceptions import MissingDependencyException
-from litestar.middleware.base import AbstractMiddleware
-
-__all__ = ("OpenTelemetryInstrumentationMiddleware",)
-
-
-try:
- import opentelemetry # noqa: F401
-except ImportError as e:
- raise MissingDependencyException("opentelemetry") from e
-
-from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
-from opentelemetry.util.http import get_excluded_urls
-
-if TYPE_CHECKING:
- from litestar.contrib.opentelemetry import OpenTelemetryConfig
- from litestar.types import ASGIApp, Receive, Scope, Send
-
-
-class OpenTelemetryInstrumentationMiddleware(AbstractMiddleware):
- """OpenTelemetry Middleware."""
-
- __slots__ = ("open_telemetry_middleware",)
-
- def __init__(self, app: ASGIApp, config: OpenTelemetryConfig) -> None:
- """Middleware that adds OpenTelemetry instrumentation to the application.
-
- Args:
- app: The ``next`` ASGI app to call.
- config: An instance of :class:`OpenTelemetryConfig <.contrib.opentelemetry.OpenTelemetryConfig>`
- """
- super().__init__(app=app, scopes=config.scopes, exclude=config.exclude, exclude_opt_key=config.exclude_opt_key)
- self.open_telemetry_middleware = OpenTelemetryMiddleware(
- app=app,
- client_request_hook=config.client_request_hook_handler,
- client_response_hook=config.client_response_hook_handler,
- default_span_details=config.scope_span_details_extractor,
- excluded_urls=get_excluded_urls(config.exclude_urls_env_key),
- meter=config.meter,
- meter_provider=config.meter_provider,
- server_request_hook=config.server_request_hook_handler,
- tracer_provider=config.tracer_provider,
- )
-
- async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
- """ASGI callable.
-
- Args:
- scope: The ASGI connection scope.
- receive: The ASGI receive function.
- send: The ASGI send function.
-
- Returns:
- None
- """
- await self.open_telemetry_middleware(scope, receive, send) # type: ignore[arg-type] # pyright: ignore[reportGeneralTypeIssues]