[Feature] OTEL tracing during loading (#31162)
This commit is contained in:
@@ -0,0 +1,127 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
||||
import threading
|
||||
from collections.abc import Callable, Generator, Iterable
|
||||
from concurrent import futures
|
||||
from typing import Any, Literal
|
||||
|
||||
import grpc
|
||||
import pytest
|
||||
from opentelemetry.proto.collector.trace.v1.trace_service_pb2 import (
|
||||
ExportTraceServiceRequest,
|
||||
ExportTraceServiceResponse,
|
||||
)
|
||||
from opentelemetry.proto.collector.trace.v1.trace_service_pb2_grpc import (
|
||||
TraceServiceServicer,
|
||||
add_TraceServiceServicer_to_server,
|
||||
)
|
||||
from opentelemetry.proto.common.v1.common_pb2 import AnyValue, KeyValue
|
||||
|
||||
FAKE_TRACE_SERVER_ADDRESS = "localhost:4317"
|
||||
|
||||
FieldName = Literal[
|
||||
"bool_value", "string_value", "int_value", "double_value", "array_value"
|
||||
]
|
||||
|
||||
|
||||
def decode_value(value: AnyValue):
|
||||
"""Decode an OpenTelemetry AnyValue protobuf message to a Python value."""
|
||||
field_decoders: dict[FieldName, Callable] = {
|
||||
"bool_value": (lambda v: v.bool_value),
|
||||
"string_value": (lambda v: v.string_value),
|
||||
"int_value": (lambda v: v.int_value),
|
||||
"double_value": (lambda v: v.double_value),
|
||||
"array_value": (
|
||||
lambda v: [decode_value(item) for item in v.array_value.values]
|
||||
),
|
||||
}
|
||||
for field, decoder in field_decoders.items():
|
||||
if value.HasField(field):
|
||||
return decoder(value)
|
||||
raise ValueError(f"Couldn't decode value: {value}")
|
||||
|
||||
|
||||
def decode_attributes(attributes: Iterable[KeyValue]) -> dict[str, Any]:
|
||||
"""Decode OpenTelemetry KeyValue attributes to a Python dictionary."""
|
||||
return {kv.key: decode_value(kv.value) for kv in attributes}
|
||||
|
||||
|
||||
class FakeTraceService(TraceServiceServicer):
|
||||
"""A fake gRPC trace service for testing OpenTelemetry trace exports."""
|
||||
|
||||
def __init__(self):
|
||||
self.requests: list[ExportTraceServiceRequest] = []
|
||||
self.evt = threading.Event()
|
||||
self._lock = threading.Lock()
|
||||
|
||||
def Export(self, request, context):
|
||||
with self._lock:
|
||||
self.requests.append(request)
|
||||
self.evt.set()
|
||||
return ExportTraceServiceResponse()
|
||||
|
||||
@property
|
||||
def request(self) -> ExportTraceServiceRequest | None:
|
||||
"""Returns the first request received (for backward compatibility)."""
|
||||
with self._lock:
|
||||
return self.requests[0] if self.requests else None
|
||||
|
||||
def get_all_spans(self) -> list[dict]:
|
||||
"""Returns all spans from all received requests as decoded dicts."""
|
||||
spans = []
|
||||
with self._lock:
|
||||
for request in self.requests:
|
||||
for resource_span in request.resource_spans:
|
||||
for scope_span in resource_span.scope_spans:
|
||||
for span in scope_span.spans:
|
||||
spans.append(
|
||||
{
|
||||
"name": span.name,
|
||||
"attributes": decode_attributes(span.attributes),
|
||||
"trace_id": span.trace_id.hex(),
|
||||
"span_id": span.span_id.hex(),
|
||||
"parent_span_id": span.parent_span_id.hex()
|
||||
if span.parent_span_id
|
||||
else None,
|
||||
"start_time_unix_nano": span.start_time_unix_nano,
|
||||
"end_time_unix_nano": span.end_time_unix_nano,
|
||||
}
|
||||
)
|
||||
return spans
|
||||
|
||||
def wait_for_spans(self, count: int = 1, timeout: float = 10) -> bool:
|
||||
"""Wait until at least `count` spans have been received."""
|
||||
import time
|
||||
|
||||
deadline = time.time() + timeout
|
||||
while time.time() < deadline:
|
||||
if len(self.get_all_spans()) >= count:
|
||||
return True
|
||||
time.sleep(0.1)
|
||||
return False
|
||||
|
||||
def clear(self):
|
||||
"""Clear all received requests."""
|
||||
with self._lock:
|
||||
self.requests.clear()
|
||||
self.evt.clear()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def trace_service() -> Generator[FakeTraceService, None, None]:
|
||||
"""Fixture to set up a fake gRPC trace service."""
|
||||
server = grpc.server(futures.ThreadPoolExecutor(max_workers=2))
|
||||
service = FakeTraceService()
|
||||
add_TraceServiceServicer_to_server(service, server)
|
||||
server.add_insecure_port(FAKE_TRACE_SERVER_ADDRESS)
|
||||
server.start()
|
||||
|
||||
yield service
|
||||
|
||||
server.stop(grace=None)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def trace_server_address() -> str:
|
||||
"""Returns the address of the fake trace server."""
|
||||
return FAKE_TRACE_SERVER_ADDRESS
|
||||
@@ -0,0 +1,87 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
||||
import asyncio
|
||||
|
||||
import pytest
|
||||
from opentelemetry.sdk.environment_variables import OTEL_EXPORTER_OTLP_TRACES_INSECURE
|
||||
|
||||
from tests.tracing.conftest import FAKE_TRACE_SERVER_ADDRESS, FakeTraceService
|
||||
from vllm.tracing import init_tracer, instrument, is_otel_available
|
||||
|
||||
# Skip everything if OTel is missing
|
||||
pytestmark = pytest.mark.skipif(not is_otel_available(), reason="OTel required")
|
||||
|
||||
|
||||
class TestCoreInstrumentation:
|
||||
"""Focuses on the @instrument decorator's ability to capture execution data."""
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def setup_tracing(self, monkeypatch):
|
||||
monkeypatch.setenv(OTEL_EXPORTER_OTLP_TRACES_INSECURE, "true")
|
||||
init_tracer("test.core", FAKE_TRACE_SERVER_ADDRESS)
|
||||
|
||||
def test_decorator_captures_sync_and_async(self, trace_service: FakeTraceService):
|
||||
"""Verify basic span creation for both sync and async functions."""
|
||||
|
||||
@instrument(span_name="sync_task")
|
||||
def sync_task():
|
||||
return True
|
||||
|
||||
@instrument(span_name="async_task")
|
||||
async def async_task():
|
||||
return True
|
||||
|
||||
sync_task()
|
||||
asyncio.run(async_task())
|
||||
|
||||
assert trace_service.wait_for_spans(count=2)
|
||||
span_names = [s["name"] for s in trace_service.get_all_spans()]
|
||||
assert "sync_task" in span_names
|
||||
assert "async_task" in span_names
|
||||
|
||||
def test_nested_spans_hierarchy(self, trace_service: FakeTraceService):
|
||||
"""Verify that nested calls create a parent-child relationship."""
|
||||
|
||||
@instrument(span_name="child")
|
||||
def child():
|
||||
pass
|
||||
|
||||
@instrument(span_name="parent")
|
||||
def parent():
|
||||
child()
|
||||
|
||||
parent()
|
||||
|
||||
assert trace_service.wait_for_spans(count=2)
|
||||
spans = trace_service.get_all_spans()
|
||||
parent_span = next(s for s in spans if s["name"] == "parent")
|
||||
child_span = next(s for s in spans if s["name"] == "child")
|
||||
|
||||
assert child_span["parent_span_id"] == parent_span["span_id"]
|
||||
|
||||
|
||||
class TestInterProcessPropagation:
|
||||
"""Test the propagation of trace context between processes."""
|
||||
|
||||
def test_pickup_external_context(self, monkeypatch, trace_service):
|
||||
"""Test that vLLM attaches to an existing trace ID if in environment."""
|
||||
monkeypatch.setenv(OTEL_EXPORTER_OTLP_TRACES_INSECURE, "true")
|
||||
|
||||
# Manually simulate an external parent trace ID
|
||||
fake_trace_id = "4bf92f3577b34da6a3ce929d0e0e4736"
|
||||
fake_parent_id = "00f067aa0ba902b7"
|
||||
monkeypatch.setenv("traceparent", f"00-{fake_trace_id}-{fake_parent_id}-01")
|
||||
|
||||
init_tracer("test.external", FAKE_TRACE_SERVER_ADDRESS)
|
||||
|
||||
@instrument(span_name="follower")
|
||||
def follower_func():
|
||||
pass
|
||||
|
||||
follower_func()
|
||||
|
||||
assert trace_service.wait_for_spans(count=1)
|
||||
span = trace_service.get_all_spans()[0]
|
||||
|
||||
assert span["trace_id"] == fake_trace_id
|
||||
assert span["parent_span_id"] == fake_parent_id
|
||||
@@ -2,76 +2,19 @@
|
||||
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
||||
# ruff: noqa
|
||||
# type: ignore
|
||||
import threading
|
||||
from collections.abc import Iterable
|
||||
from concurrent import futures
|
||||
from typing import Callable, Generator, Literal
|
||||
|
||||
import grpc
|
||||
import pytest
|
||||
from opentelemetry.proto.collector.trace.v1.trace_service_pb2 import (
|
||||
ExportTraceServiceResponse,
|
||||
)
|
||||
from opentelemetry.proto.collector.trace.v1.trace_service_pb2_grpc import (
|
||||
TraceServiceServicer,
|
||||
add_TraceServiceServicer_to_server,
|
||||
)
|
||||
from opentelemetry.proto.common.v1.common_pb2 import AnyValue, KeyValue
|
||||
import time
|
||||
from opentelemetry.sdk.environment_variables import OTEL_EXPORTER_OTLP_TRACES_INSECURE
|
||||
|
||||
from vllm import LLM, SamplingParams
|
||||
from vllm.tracing import SpanAttributes
|
||||
|
||||
FAKE_TRACE_SERVER_ADDRESS = "localhost:4317"
|
||||
|
||||
FieldName = Literal[
|
||||
"bool_value", "string_value", "int_value", "double_value", "array_value"
|
||||
]
|
||||
|
||||
|
||||
def decode_value(value: AnyValue):
|
||||
field_decoders: dict[FieldName, Callable] = {
|
||||
"bool_value": (lambda v: v.bool_value),
|
||||
"string_value": (lambda v: v.string_value),
|
||||
"int_value": (lambda v: v.int_value),
|
||||
"double_value": (lambda v: v.double_value),
|
||||
"array_value": (
|
||||
lambda v: [decode_value(item) for item in v.array_value.values]
|
||||
),
|
||||
}
|
||||
for field, decoder in field_decoders.items():
|
||||
if value.HasField(field):
|
||||
return decoder(value)
|
||||
raise ValueError(f"Couldn't decode value: {value}")
|
||||
|
||||
|
||||
def decode_attributes(attributes: Iterable[KeyValue]):
|
||||
return {kv.key: decode_value(kv.value) for kv in attributes}
|
||||
|
||||
|
||||
class FakeTraceService(TraceServiceServicer):
|
||||
def __init__(self):
|
||||
self.request = None
|
||||
self.evt = threading.Event()
|
||||
|
||||
def Export(self, request, context):
|
||||
self.request = request
|
||||
self.evt.set()
|
||||
return ExportTraceServiceResponse()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def trace_service() -> Generator[FakeTraceService, None, None]:
|
||||
"""Fixture to set up a fake gRPC trace service"""
|
||||
server = grpc.server(futures.ThreadPoolExecutor(max_workers=1))
|
||||
service = FakeTraceService()
|
||||
add_TraceServiceServicer_to_server(service, server)
|
||||
server.add_insecure_port(FAKE_TRACE_SERVER_ADDRESS)
|
||||
server.start()
|
||||
|
||||
yield service
|
||||
|
||||
server.stop(None)
|
||||
# Import shared fixtures from the tracing conftest
|
||||
from tests.tracing.conftest import ( # noqa: F401
|
||||
FAKE_TRACE_SERVER_ADDRESS,
|
||||
FakeTraceService,
|
||||
trace_service,
|
||||
)
|
||||
|
||||
|
||||
def test_traces(
|
||||
@@ -97,29 +40,25 @@ def test_traces(
|
||||
outputs = llm.generate(prompts, sampling_params=sampling_params)
|
||||
print(f"test_traces outputs is : {outputs}")
|
||||
|
||||
timeout = 10
|
||||
if not trace_service.evt.wait(timeout):
|
||||
raise TimeoutError(
|
||||
f"The fake trace service didn't receive a trace within "
|
||||
f"the {timeout} seconds timeout"
|
||||
)
|
||||
# Wait for the "llm_request" span to be exported.
|
||||
# The BatchSpanProcessor batches spans and exports them periodically,
|
||||
# so we need to wait specifically for the llm_request span to appear.
|
||||
timeout = 15
|
||||
deadline = time.time() + timeout
|
||||
llm_request_spans = []
|
||||
while time.time() < deadline:
|
||||
all_spans = trace_service.get_all_spans()
|
||||
llm_request_spans = [s for s in all_spans if s["name"] == "llm_request"]
|
||||
if llm_request_spans:
|
||||
break
|
||||
time.sleep(0.5)
|
||||
|
||||
request = trace_service.request
|
||||
assert len(request.resource_spans) == 1, (
|
||||
f"Expected 1 resource span, but got {len(request.resource_spans)}"
|
||||
)
|
||||
assert len(request.resource_spans[0].scope_spans) == 1, (
|
||||
f"Expected 1 scope span, "
|
||||
f"but got {len(request.resource_spans[0].scope_spans)}"
|
||||
)
|
||||
assert len(request.resource_spans[0].scope_spans[0].spans) == 1, (
|
||||
f"Expected 1 span, "
|
||||
f"but got {len(request.resource_spans[0].scope_spans[0].spans)}"
|
||||
assert len(llm_request_spans) == 1, (
|
||||
f"Expected exactly 1 'llm_request' span, but got {len(llm_request_spans)}. "
|
||||
f"All span names: {[s['name'] for s in all_spans]}"
|
||||
)
|
||||
|
||||
attributes = decode_attributes(
|
||||
request.resource_spans[0].scope_spans[0].spans[0].attributes
|
||||
)
|
||||
attributes = llm_request_spans[0]["attributes"]
|
||||
# assert attributes.get(SpanAttributes.GEN_AI_RESPONSE_MODEL) == model
|
||||
assert attributes.get(SpanAttributes.GEN_AI_REQUEST_ID) == outputs[0].request_id
|
||||
assert (
|
||||
|
||||
Reference in New Issue
Block a user