File size: 6,695 Bytes
ce676f7 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | # SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0
import sys
from unittest.mock import Mock, patch
import ddtrace
import opentelemetry.trace
import pytest
from _pytest.monkeypatch import MonkeyPatch
from opentelemetry.sdk.resources import SERVICE_NAME, Resource
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
from haystack.tracing.datadog import DatadogTracer
from haystack.tracing.opentelemetry import OpenTelemetryTracer
from haystack.tracing.tracer import (
NullTracer,
NullSpan,
_auto_configured_opentelemetry_tracer,
_auto_configured_datadog_tracer,
enable_tracing,
Tracer,
disable_tracing,
is_tracing_enabled,
ProxyTracer,
auto_enable_tracing,
tracer,
HAYSTACK_CONTENT_TRACING_ENABLED_ENV_VAR,
)
from test.tracing.utils import SpyingTracer, SpyingSpan
class TestNullTracer:
def test_tracing(self) -> None:
assert isinstance(tracer.actual_tracer, NullTracer)
# None of this raises
with tracer.trace("operation", {"key": "value"}, parent_span=None) as span:
span.set_tag("key", "value")
span.set_tags({"key": "value"})
assert isinstance(tracer.current_span(), NullSpan)
assert isinstance(tracer.current_span().raw_span(), NullSpan)
class TestProxyTracer:
def test_tracing(self) -> None:
spying_tracer = SpyingTracer()
my_tracer = ProxyTracer(provided_tracer=spying_tracer)
parent_span = Mock(spec=SpyingSpan)
with my_tracer.trace("operation", {"key": "value"}, parent_span=parent_span) as span:
span.set_tag("key", "value")
span.set_tags({"key2": "value2"})
assert len(spying_tracer.spans) == 1
assert spying_tracer.spans[0].operation_name == "operation"
assert spying_tracer.spans[0].parent_span == parent_span
assert spying_tracer.spans[0].tags == {"key": "value", "key2": "value2"}
class TestConfigureTracer:
def test_enable_tracer(self) -> None:
my_tracer = Mock(spec=Tracer) # anything else than `NullTracer` works for this test
enable_tracing(my_tracer)
assert isinstance(tracer, ProxyTracer)
assert tracer.actual_tracer is my_tracer
assert is_tracing_enabled()
def test_disable_tracing(self) -> None:
my_tracker = Mock(spec=Tracer) # anything else than `NullTracer` works for this test
enable_tracing(my_tracker)
assert tracer.actual_tracer is my_tracker
disable_tracing()
assert isinstance(tracer.actual_tracer, NullTracer)
assert is_tracing_enabled() is False
class TestAutoEnableTracer:
@pytest.fixture()
def configured_opentelemetry_tracing(self) -> None:
resource = Resource(attributes={SERVICE_NAME: "haystack-testing"})
traceProvider = TracerProvider(resource=resource)
processor = SimpleSpanProcessor(InMemorySpanExporter())
traceProvider.add_span_processor(processor)
# We can't unset `set_tracer_provider` here, because opentelemetry has a lock to only set it once
opentelemetry.trace._TRACER_PROVIDER = traceProvider
yield
# unfortunately, there's no cleaner way to reset the global tracer provider
opentelemetry.trace._TRACER_PROVIDER = None
disable_tracing()
def test_skip_auto_enable_tracer_if_already_configured(self) -> None:
my_tracker = Mock(spec=Tracer) # anything else than `NullTracer` works for this test
enable_tracing(my_tracker)
auto_enable_tracing()
assert tracer.actual_tracer is my_tracker
def test_skip_auto_enable_if_tracing_disabled_via_env(
self, monkeypatch: MonkeyPatch, configured_opentelemetry_tracing: None
) -> None:
monkeypatch.setenv("HAYSTACK_AUTO_TRACE_ENABLED", "false")
old_tracer = tracer.actual_tracer
auto_enable_tracing()
assert tracer.actual_tracer is old_tracer
def test_enable_opentelemetry_tracer(self, configured_opentelemetry_tracing: None) -> None:
auto_enable_tracing()
activated_tracer = tracer.actual_tracer
assert isinstance(activated_tracer, OpenTelemetryTracer)
assert is_tracing_enabled()
def test_add_datadog_tracer(self) -> None:
auto_enable_tracing()
activated_tracer = tracer.actual_tracer
assert isinstance(activated_tracer, DatadogTracer)
assert is_tracing_enabled()
def test__auto_configured_opentelemetry_tracer(self, configured_opentelemetry_tracing):
tracer = _auto_configured_opentelemetry_tracer()
assert isinstance(tracer, OpenTelemetryTracer)
def test__auto_configured_opentelemetry_tracer_with_failing_import(self, monkeypatch):
monkeypatch.delitem(sys.modules, "opentelemetry.trace", raising=False)
tracer = _auto_configured_opentelemetry_tracer()
assert tracer is None
def test__auto_configured_datadog_tracer(self):
tracer = _auto_configured_datadog_tracer()
assert isinstance(tracer, DatadogTracer)
def test__auto_configured_datadog_tracer_with_failing_import(self, monkeypatch):
monkeypatch.setattr(ddtrace.tracer, "enabled", False)
tracer = _auto_configured_datadog_tracer()
assert tracer is None
class TestTracingContent:
def test_set_content_tag_with_default_settings(self, spying_tracer: SpyingTracer) -> None:
with tracer.trace("test") as span:
span.set_content_tag("my_content", "my_content")
assert len(spying_tracer.spans) == 1
span = spying_tracer.spans[0]
assert span.tags == {}
def test_set_content_tag_with_enabled_content_tracing(
self, monkeypatch: MonkeyPatch, spying_tracer: SpyingTracer
) -> None:
enable_tracing(spying_tracer)
# monkeypatch to avoid impact on other tests
monkeypatch.setattr(tracer, "is_content_tracing_enabled", True)
with tracer.trace("test") as span:
span.set_content_tag("my_content", "my_content")
assert len(spying_tracer.spans) == 1
span = spying_tracer.spans[0]
assert span.tags == {"my_content": "my_content"}
def test_set_content_tag_when_enabled_via_env_variable(self, monkeypatch: MonkeyPatch) -> None:
monkeypatch.setenv(HAYSTACK_CONTENT_TRACING_ENABLED_ENV_VAR, "true")
proxy_tracer = ProxyTracer(provided_tracer=SpyingTracer())
assert proxy_tracer.is_content_tracing_enabled is True
|