mirror of
https://github.com/BerriAI/litellm.git
synced 2025-04-26 19:24:27 +00:00
327 lines
12 KiB
Python
327 lines
12 KiB
Python
import os
|
|
from dataclasses import dataclass
|
|
from datetime import datetime
|
|
|
|
from litellm.integrations.custom_logger import CustomLogger
|
|
from litellm._logging import verbose_logger
|
|
from litellm.types.services import ServiceLoggerPayload
|
|
from typing import Union, Optional, TYPE_CHECKING, Any
|
|
|
|
if TYPE_CHECKING:
|
|
from opentelemetry.trace import Span as _Span
|
|
from litellm.proxy.proxy_server import UserAPIKeyAuth as _UserAPIKeyAuth
|
|
|
|
Span = _Span
|
|
UserAPIKeyAuth = _UserAPIKeyAuth
|
|
else:
|
|
Span = Any
|
|
UserAPIKeyAuth = Any
|
|
|
|
|
|
LITELLM_TRACER_NAME = os.getenv("OTEL_TRACER_NAME", "litellm")
|
|
LITELLM_RESOURCE = {
|
|
"service.name": os.getenv("OTEL_SERVICE_NAME", "litellm"),
|
|
}
|
|
|
|
|
|
@dataclass
|
|
class OpenTelemetryConfig:
|
|
from opentelemetry.sdk.trace.export import SpanExporter
|
|
|
|
exporter: str | SpanExporter = "console"
|
|
endpoint: Optional[str] = None
|
|
headers: Optional[str] = None
|
|
|
|
@classmethod
|
|
def from_env(cls):
|
|
"""
|
|
OTEL_HEADERS=x-honeycomb-team=B85YgLm9****
|
|
OTEL_EXPORTER="otlp_http"
|
|
OTEL_ENDPOINT="https://api.honeycomb.io/v1/traces"
|
|
|
|
OTEL_HEADERS gets sent as headers = {"x-honeycomb-team": "B85YgLm96******"}
|
|
"""
|
|
return cls(
|
|
exporter=os.getenv("OTEL_EXPORTER", "console"),
|
|
endpoint=os.getenv("OTEL_ENDPOINT"),
|
|
headers=os.getenv(
|
|
"OTEL_HEADERS"
|
|
), # example: OTEL_HEADERS=x-honeycomb-team=B85YgLm96VGdFisfJVme1H"
|
|
)
|
|
|
|
|
|
class OpenTelemetry(CustomLogger):
|
|
def __init__(self, config=OpenTelemetryConfig.from_env()):
|
|
from opentelemetry import trace
|
|
from opentelemetry.sdk.resources import Resource
|
|
from opentelemetry.sdk.trace import TracerProvider
|
|
|
|
self.config = config
|
|
self.OTEL_EXPORTER = self.config.exporter
|
|
self.OTEL_ENDPOINT = self.config.endpoint
|
|
self.OTEL_HEADERS = self.config.headers
|
|
provider = TracerProvider(resource=Resource(attributes=LITELLM_RESOURCE))
|
|
provider.add_span_processor(self._get_span_processor())
|
|
|
|
trace.set_tracer_provider(provider)
|
|
self.tracer = trace.get_tracer(LITELLM_TRACER_NAME)
|
|
|
|
if bool(os.getenv("DEBUG_OTEL", False)) is True:
|
|
# Set up logging
|
|
import logging
|
|
|
|
logging.basicConfig(level=logging.DEBUG)
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Enable OpenTelemetry logging
|
|
otel_exporter_logger = logging.getLogger("opentelemetry.sdk.trace.export")
|
|
otel_exporter_logger.setLevel(logging.DEBUG)
|
|
|
|
def log_success_event(self, kwargs, response_obj, start_time, end_time):
|
|
self._handle_sucess(kwargs, response_obj, start_time, end_time)
|
|
|
|
def log_failure_event(self, kwargs, response_obj, start_time, end_time):
|
|
self._handle_failure(kwargs, response_obj, start_time, end_time)
|
|
|
|
async def async_log_success_event(self, kwargs, response_obj, start_time, end_time):
|
|
self._handle_sucess(kwargs, response_obj, start_time, end_time)
|
|
|
|
async def async_log_failure_event(self, kwargs, response_obj, start_time, end_time):
|
|
self._handle_failure(kwargs, response_obj, start_time, end_time)
|
|
|
|
async def async_service_success_hook(
|
|
self,
|
|
payload: ServiceLoggerPayload,
|
|
parent_otel_span: Optional[Span] = None,
|
|
start_time: Optional[datetime] = None,
|
|
end_time: Optional[datetime] = None,
|
|
):
|
|
from opentelemetry import trace
|
|
from datetime import datetime
|
|
from opentelemetry.trace import Status, StatusCode
|
|
|
|
_start_time_ns = start_time
|
|
_end_time_ns = end_time
|
|
|
|
if isinstance(start_time, float):
|
|
_start_time_ns = int(int(start_time) * 1e9)
|
|
else:
|
|
_start_time_ns = self._to_ns(start_time)
|
|
|
|
if isinstance(end_time, float):
|
|
_end_time_ns = int(int(end_time) * 1e9)
|
|
else:
|
|
_end_time_ns = self._to_ns(end_time)
|
|
|
|
if parent_otel_span is not None:
|
|
_span_name = payload.service
|
|
service_logging_span = self.tracer.start_span(
|
|
name=_span_name,
|
|
context=trace.set_span_in_context(parent_otel_span),
|
|
start_time=_start_time_ns,
|
|
)
|
|
service_logging_span.set_attribute(key="call_type", value=payload.call_type)
|
|
service_logging_span.set_attribute(
|
|
key="service", value=payload.service.value
|
|
)
|
|
service_logging_span.set_status(Status(StatusCode.OK))
|
|
service_logging_span.end(end_time=_end_time_ns)
|
|
|
|
async def async_service_failure_hook(
|
|
self,
|
|
payload: ServiceLoggerPayload,
|
|
parent_otel_span: Optional[Span] = None,
|
|
start_time: Optional[datetime] = None,
|
|
end_time: Optional[datetime] = None,
|
|
):
|
|
from opentelemetry import trace
|
|
from datetime import datetime
|
|
from opentelemetry.trace import Status, StatusCode
|
|
|
|
_start_time_ns = start_time
|
|
_end_time_ns = end_time
|
|
|
|
if isinstance(start_time, float):
|
|
_start_time_ns = int(int(start_time) * 1e9)
|
|
else:
|
|
_start_time_ns = self._to_ns(start_time)
|
|
|
|
if isinstance(end_time, float):
|
|
_end_time_ns = int(int(end_time) * 1e9)
|
|
else:
|
|
_end_time_ns = self._to_ns(end_time)
|
|
|
|
if parent_otel_span is not None:
|
|
_span_name = payload.service
|
|
service_logging_span = self.tracer.start_span(
|
|
name=_span_name,
|
|
context=trace.set_span_in_context(parent_otel_span),
|
|
start_time=_start_time_ns,
|
|
)
|
|
service_logging_span.set_attribute(key="call_type", value=payload.call_type)
|
|
service_logging_span.set_attribute(
|
|
key="service", value=payload.service.value
|
|
)
|
|
service_logging_span.set_status(Status(StatusCode.ERROR))
|
|
service_logging_span.end(end_time=_end_time_ns)
|
|
|
|
async def async_post_call_failure_hook(
|
|
self, original_exception: Exception, user_api_key_dict: UserAPIKeyAuth
|
|
):
|
|
from opentelemetry.trace import Status, StatusCode
|
|
from opentelemetry import trace
|
|
|
|
parent_otel_span = user_api_key_dict.parent_otel_span
|
|
if parent_otel_span is not None:
|
|
parent_otel_span.set_status(Status(StatusCode.ERROR))
|
|
_span_name = "Failed Proxy Server Request"
|
|
|
|
# Exception Logging Child Span
|
|
exception_logging_span = self.tracer.start_span(
|
|
name=_span_name,
|
|
context=trace.set_span_in_context(parent_otel_span),
|
|
)
|
|
exception_logging_span.set_attribute(
|
|
key="exception", value=str(original_exception)
|
|
)
|
|
exception_logging_span.set_status(Status(StatusCode.ERROR))
|
|
exception_logging_span.end(end_time=self._to_ns(datetime.now()))
|
|
|
|
# End Parent OTEL Sspan
|
|
parent_otel_span.end(end_time=self._to_ns(datetime.now()))
|
|
|
|
def _handle_sucess(self, kwargs, response_obj, start_time, end_time):
|
|
from opentelemetry.trace import Status, StatusCode
|
|
|
|
verbose_logger.debug(
|
|
"OpenTelemetry Logger: Logging kwargs: %s, OTEL config settings=%s",
|
|
kwargs,
|
|
self.config,
|
|
)
|
|
_parent_context, parent_otel_span = self._get_span_context(kwargs)
|
|
|
|
span = self.tracer.start_span(
|
|
name=self._get_span_name(kwargs),
|
|
start_time=self._to_ns(start_time),
|
|
context=_parent_context,
|
|
)
|
|
span.set_status(Status(StatusCode.OK))
|
|
self.set_attributes(span, kwargs, response_obj)
|
|
span.end(end_time=self._to_ns(end_time))
|
|
if parent_otel_span is not None:
|
|
parent_otel_span.end(end_time=self._to_ns(datetime.now()))
|
|
|
|
def _handle_failure(self, kwargs, response_obj, start_time, end_time):
|
|
from opentelemetry.trace import Status, StatusCode
|
|
|
|
span = self.tracer.start_span(
|
|
name=self._get_span_name(kwargs),
|
|
start_time=self._to_ns(start_time),
|
|
context=self._get_span_context(kwargs),
|
|
)
|
|
span.set_status(Status(StatusCode.ERROR))
|
|
self.set_attributes(span, kwargs, response_obj)
|
|
span.end(end_time=self._to_ns(end_time))
|
|
|
|
def set_attributes(self, span, kwargs, response_obj):
|
|
for key in ["model", "api_base", "api_version"]:
|
|
if key in kwargs:
|
|
span.set_attribute(key, kwargs[key])
|
|
|
|
def _to_ns(self, dt):
|
|
return int(dt.timestamp() * 1e9)
|
|
|
|
def _get_span_name(self, kwargs):
|
|
return f"litellm-{kwargs.get('call_type', 'completion')}"
|
|
|
|
def _get_span_context(self, kwargs):
|
|
from opentelemetry.trace.propagation.tracecontext import (
|
|
TraceContextTextMapPropagator,
|
|
)
|
|
from opentelemetry import trace
|
|
|
|
litellm_params = kwargs.get("litellm_params", {}) or {}
|
|
proxy_server_request = litellm_params.get("proxy_server_request", {}) or {}
|
|
headers = proxy_server_request.get("headers", {}) or {}
|
|
traceparent = headers.get("traceparent", None)
|
|
_metadata = litellm_params.get("metadata", {})
|
|
parent_otel_span = _metadata.get("litellm_parent_otel_span", None)
|
|
|
|
"""
|
|
Two way to use parents in opentelemetry
|
|
- using the traceparent header
|
|
- using the parent_otel_span in the [metadata][parent_otel_span]
|
|
"""
|
|
if parent_otel_span is not None:
|
|
return trace.set_span_in_context(parent_otel_span), parent_otel_span
|
|
|
|
if traceparent is None:
|
|
return None, None
|
|
else:
|
|
carrier = {"traceparent": traceparent}
|
|
return TraceContextTextMapPropagator().extract(carrier=carrier), None
|
|
|
|
def _get_span_processor(self):
|
|
from opentelemetry.sdk.trace.export import (
|
|
SpanExporter,
|
|
SimpleSpanProcessor,
|
|
BatchSpanProcessor,
|
|
ConsoleSpanExporter,
|
|
)
|
|
from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
|
|
OTLPSpanExporter as OTLPSpanExporterHTTP,
|
|
)
|
|
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
|
|
OTLPSpanExporter as OTLPSpanExporterGRPC,
|
|
)
|
|
|
|
verbose_logger.debug(
|
|
"OpenTelemetry Logger, initializing span processor \nself.OTEL_EXPORTER: %s\nself.OTEL_ENDPOINT: %s\nself.OTEL_HEADERS: %s",
|
|
self.OTEL_EXPORTER,
|
|
self.OTEL_ENDPOINT,
|
|
self.OTEL_HEADERS,
|
|
)
|
|
_split_otel_headers = {}
|
|
if self.OTEL_HEADERS is not None and isinstance(self.OTEL_HEADERS, str):
|
|
_split_otel_headers = self.OTEL_HEADERS.split("=")
|
|
_split_otel_headers = {_split_otel_headers[0]: _split_otel_headers[1]}
|
|
|
|
if isinstance(self.OTEL_EXPORTER, SpanExporter):
|
|
verbose_logger.debug(
|
|
"OpenTelemetry: intiializing SpanExporter. Value of OTEL_EXPORTER: %s",
|
|
self.OTEL_EXPORTER,
|
|
)
|
|
return SimpleSpanProcessor(self.OTEL_EXPORTER)
|
|
|
|
if self.OTEL_EXPORTER == "console":
|
|
verbose_logger.debug(
|
|
"OpenTelemetry: intiializing console exporter. Value of OTEL_EXPORTER: %s",
|
|
self.OTEL_EXPORTER,
|
|
)
|
|
return BatchSpanProcessor(ConsoleSpanExporter())
|
|
elif self.OTEL_EXPORTER == "otlp_http":
|
|
verbose_logger.debug(
|
|
"OpenTelemetry: intiializing http exporter. Value of OTEL_EXPORTER: %s",
|
|
self.OTEL_EXPORTER,
|
|
)
|
|
return BatchSpanProcessor(
|
|
OTLPSpanExporterHTTP(
|
|
endpoint=self.OTEL_ENDPOINT, headers=_split_otel_headers
|
|
)
|
|
)
|
|
elif self.OTEL_EXPORTER == "otlp_grpc":
|
|
verbose_logger.debug(
|
|
"OpenTelemetry: intiializing grpc exporter. Value of OTEL_EXPORTER: %s",
|
|
self.OTEL_EXPORTER,
|
|
)
|
|
return BatchSpanProcessor(
|
|
OTLPSpanExporterGRPC(
|
|
endpoint=self.OTEL_ENDPOINT, headers=_split_otel_headers
|
|
)
|
|
)
|
|
else:
|
|
verbose_logger.debug(
|
|
"OpenTelemetry: intiializing console exporter. Value of OTEL_EXPORTER: %s",
|
|
self.OTEL_EXPORTER,
|
|
)
|
|
return BatchSpanProcessor(ConsoleSpanExporter())
|