mirror of
https://github.com/deepset-ai/haystack.git
synced 2025-07-04 07:26:15 +00:00
f911459647
* feat: add resource name for Haystack Component Datadog spans * fest: format resource name Signed-off-by: Ahmad Zidan <ahmad.zidan@traveloka.com> * feat: add release notes Signed-off-by: Ahmad Zidan <ahmad.zidan@traveloka.com> --------- Signed-off-by: Ahmad Zidan <ahmad.zidan@traveloka.com> Co-authored-by: Sebastian Husch Lee <10526848+sjrl@users.noreply.github.com>
121 lines
4.2 KiB
Python
121 lines
4.2 KiB
Python
# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
import functools
|
|
import json
|
|
from typing import List, Dict
|
|
|
|
from ddtrace.trace import Span as ddSpan
|
|
from ddtrace.trace import Tracer as ddTracer
|
|
from ddtrace._trace.processor import SpanAggregator
|
|
import pytest
|
|
from _pytest.capture import CaptureFixture
|
|
from _pytest.monkeypatch import MonkeyPatch
|
|
|
|
from haystack.tracing.datadog import DatadogTracer
|
|
|
|
|
|
def safe_patch(monkeypatch, target, attr_name, replacement):
|
|
if hasattr(target, attr_name):
|
|
attr = getattr(target, attr_name)
|
|
name = attr.__name__ if callable(attr) and hasattr(attr, "__name__") else attr_name
|
|
monkeypatch.setattr(target, name, replacement)
|
|
|
|
|
|
@pytest.fixture()
|
|
def datadog_tracer(monkeypatch: MonkeyPatch) -> ddTracer:
|
|
# For the purpose of the tests we want to use the log writer
|
|
safe_patch(monkeypatch, SpanAggregator, "_use_log_writer", lambda *_: True)
|
|
safe_patch(monkeypatch, ddTracer, "_use_log_writer", lambda *_: True)
|
|
|
|
tracer = ddTracer()
|
|
|
|
return tracer
|
|
|
|
|
|
def get_traces_from_console(capfd: CaptureFixture) -> List[Dict]:
|
|
output = capfd.readouterr().out
|
|
parsed = json.loads(output)
|
|
nested_traces = parsed["traces"]
|
|
flattened = list(functools.reduce(lambda x, y: x + y, nested_traces, []))
|
|
|
|
return flattened
|
|
|
|
|
|
class TestDatadogTracer:
|
|
def test_opentelemetry_tracer(self, datadog_tracer: ddTracer, capfd: CaptureFixture) -> None:
|
|
tracer = DatadogTracer(datadog_tracer)
|
|
|
|
component_tags = {
|
|
"haystack.component.name": "test_component",
|
|
"haystack.component.type": "TestType",
|
|
"haystack.component.input": {"input_key": "input_value"},
|
|
"haystack.component.output": {"output_key": "output_value"},
|
|
}
|
|
|
|
with tracer.trace("haystack.component.run", tags=component_tags) as span:
|
|
span.set_tag("key", "value")
|
|
|
|
traces = get_traces_from_console(capfd)
|
|
assert len(traces) == 1
|
|
|
|
trace = traces[0]
|
|
|
|
assert trace["name"] == "haystack.component.run"
|
|
assert "test_component" in trace["resource"]
|
|
assert "TestType" in trace["resource"]
|
|
|
|
def test_tagging(self, datadog_tracer: ddTracer, capfd: CaptureFixture) -> None:
|
|
tracer = DatadogTracer(datadog_tracer)
|
|
|
|
with tracer.trace("test", tags={"key1": "value1"}) as span:
|
|
span.set_tag("key2", "value2")
|
|
|
|
spans = get_traces_from_console(capfd)
|
|
assert len(spans) == 1
|
|
assert spans[0]["meta"]["key1"] == "value1"
|
|
assert spans[0]["meta"]["key2"] == "value2"
|
|
|
|
def test_current_span(self, datadog_tracer: ddTracer, capfd: CaptureFixture) -> None:
|
|
tracer = DatadogTracer(datadog_tracer)
|
|
|
|
with tracer.trace("test"):
|
|
current_span = tracer.current_span()
|
|
assert tracer.current_span() is not None
|
|
|
|
current_span.set_tag("key1", "value1")
|
|
|
|
raw_span = current_span.raw_span()
|
|
assert raw_span is not None
|
|
assert isinstance(raw_span, ddSpan)
|
|
|
|
raw_span.set_tag("key2", "value2")
|
|
|
|
spans = get_traces_from_console(capfd)
|
|
assert len(spans) == 1
|
|
assert spans[0]["meta"]["key1"] == "value1"
|
|
assert spans[0]["meta"]["key2"] == "value2"
|
|
|
|
def test_tracing_complex_values(self, datadog_tracer: ddTracer, capfd: CaptureFixture) -> None:
|
|
tracer = DatadogTracer(datadog_tracer)
|
|
|
|
with tracer.trace("test") as span:
|
|
span.set_tag("key", {"a": 1, "b": [2, 3, 4]})
|
|
|
|
spans = get_traces_from_console(capfd)
|
|
assert len(spans) == 1
|
|
assert spans[0]["meta"]["key"] == '{"a": 1, "b": [2, 3, 4]}'
|
|
|
|
def test_get_log_correlation_info(self, datadog_tracer: ddTracer) -> None:
|
|
tracer = DatadogTracer(datadog_tracer)
|
|
with tracer.trace("test") as span:
|
|
span.set_tag("key", "value")
|
|
assert span.get_correlation_data_for_logs() == {
|
|
"dd.trace_id": str((1 << 64) - 1 & span.raw_span().trace_id),
|
|
"dd.span_id": span.raw_span().span_id,
|
|
"dd.service": "",
|
|
"dd.env": "",
|
|
"dd.version": "",
|
|
}
|