File size: 8,115 Bytes
4ff79c6 | 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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | # SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0
import abc
import contextlib
import os
from typing import Any, Dict, Iterator, Optional
from haystack import logging
HAYSTACK_AUTO_TRACE_ENABLED_ENV_VAR = "HAYSTACK_AUTO_TRACE_ENABLED"
HAYSTACK_CONTENT_TRACING_ENABLED_ENV_VAR = "HAYSTACK_CONTENT_TRACING_ENABLED"
logger = logging.getLogger(__name__)
class Span(abc.ABC):
"""Interface for an instrumented operation."""
@abc.abstractmethod
def set_tag(self, key: str, value: Any) -> None:
"""
Set a single tag on the span.
Note that the value will be serialized to a string, so it's best to use simple types like strings, numbers, or
booleans.
:param key: the name of the tag.
:param value: the value of the tag.
"""
pass
def set_tags(self, tags: Dict[str, Any]) -> None:
"""
Set multiple tags on the span.
:param tags: a mapping of tag names to tag values.
"""
for key, value in tags.items():
self.set_tag(key, value)
def raw_span(self) -> Any:
"""
Provides access to the underlying span object of the tracer.
Use this if you need full access to the underlying span object.
:return: The underlying span object.
"""
return self
def set_content_tag(self, key: str, value: Any) -> None:
"""
Set a single tag containing content information.
Content is sensitive information such as
- the content of a query
- the content of a document
- the content of an answer
By default, this behavior is disabled. To enable it
- set the environment variable `HAYSTACK_CONTENT_TRACING_ENABLED` to `true` or
- override the `set_content_tag` method in a custom tracer implementation.
:param key: the name of the tag.
:param value: the value of the tag.
"""
if tracer.is_content_tracing_enabled:
self.set_tag(key, value)
def get_correlation_data_for_logs(self) -> Dict[str, Any]:
"""
Return a dictionary with correlation data for logs.
This is useful if you want to correlate logs with traces.
"""
return {}
class Tracer(abc.ABC):
"""Interface for instrumenting code by creating and submitting spans."""
@abc.abstractmethod
@contextlib.contextmanager
def trace(
self, operation_name: str, tags: Optional[Dict[str, Any]] = None, parent_span: Optional[Span] = None
) -> Iterator[Span]:
"""
Trace the execution of a block of code.
:param operation_name: the name of the operation being traced.
:param tags: tags to apply to the newly created span.
:param parent_span: the parent span to use for the newly created span.
If `None`, the newly created span will be a root span.
:return: the newly created span.
"""
pass
@abc.abstractmethod
def current_span(self) -> Optional[Span]:
"""
Returns the currently active span. If no span is active, returns `None`.
:return: Currently active span or `None` if no span is active.
"""
pass
class ProxyTracer(Tracer):
"""
Container for the actual tracer instance.
This eases
- replacing the actual tracer instance without having to change the global tracer instance
- implementing default behavior for the tracer
"""
def __init__(self, provided_tracer: Tracer) -> None:
self.actual_tracer: Tracer = provided_tracer
self.is_content_tracing_enabled = os.getenv(HAYSTACK_CONTENT_TRACING_ENABLED_ENV_VAR, "false").lower() == "true"
@contextlib.contextmanager
def trace(
self, operation_name: str, tags: Optional[Dict[str, Any]] = None, parent_span: Optional[Span] = None
) -> Iterator[Span]:
"""Activate and return a new span that inherits from the current active span."""
with self.actual_tracer.trace(operation_name, tags=tags, parent_span=parent_span) as span:
yield span
def current_span(self) -> Optional[Span]:
"""Return the current active span"""
return self.actual_tracer.current_span()
class NullSpan(Span):
"""A no-op implementation of the `Span` interface. This is used when tracing is disabled."""
def set_tag(self, key: str, value: Any) -> None:
"""Set a single tag on the span."""
pass
class NullTracer(Tracer):
"""A no-op implementation of the `Tracer` interface. This is used when tracing is disabled."""
@contextlib.contextmanager
def trace(
self, operation_name: str, tags: Optional[Dict[str, Any]] = None, parent_span: Optional[Span] = None
) -> Iterator[Span]:
"""Activate and return a new span that inherits from the current active span."""
yield NullSpan()
def current_span(self) -> Optional[Span]:
"""Return the current active span"""
return NullSpan()
# We use the proxy pattern to allow for easy enabling and disabling of tracing without having to change the global
# tracer instance. That's especially convenient if users import the object directly
# (in that case we'd have to monkey-patch it in all of these modules).
tracer: ProxyTracer = ProxyTracer(provided_tracer=NullTracer())
def enable_tracing(provided_tracer: Tracer) -> None:
"""Enable tracing by setting the global tracer instance."""
tracer.actual_tracer = provided_tracer
def disable_tracing() -> None:
"""Disable tracing by setting the global tracer instance to a no-op tracer."""
tracer.actual_tracer = NullTracer()
def is_tracing_enabled() -> bool:
"""Return whether tracing is enabled."""
return not isinstance(tracer.actual_tracer, NullTracer)
def auto_enable_tracing() -> None:
"""
Auto-enable the right tracing backend.
This behavior can be disabled by setting the environment variable `HAYSTACK_AUTO_TRACE_ENABLED` to `false`.
Note that it will only work correctly if tracing was configured _before_ Haystack is imported.
"""
if os.getenv(HAYSTACK_AUTO_TRACE_ENABLED_ENV_VAR, "true").lower() == "false":
logger.info(
"Tracing disabled via environment variable '{env_key}'", env_key=HAYSTACK_AUTO_TRACE_ENABLED_ENV_VAR
)
return
if is_tracing_enabled():
return # tracing already enabled
tracer = _auto_configured_opentelemetry_tracer() or _auto_configured_datadog_tracer()
if tracer:
enable_tracing(tracer)
logger.info("Auto-enabled tracing for '{tracer}'", tracer=tracer.__class__.__name__)
def _auto_configured_opentelemetry_tracer() -> Optional[Tracer]:
# we implement this here and not in the `opentelemetry` module to avoid import warnings when OpenTelemetry is not
# installed
try:
import opentelemetry.trace
# the safest way to check if tracing is enabled is to try to start a span and see if it's a no-op span
# alternatively we could of course check `opentelemetry.trace._TRACER_PROVIDER`
# but that's not part of the public API and could change in the future
with opentelemetry.trace.get_tracer("haystack").start_as_current_span("haystack.tracing.auto_enable") as span:
if isinstance(span, opentelemetry.trace.NonRecordingSpan):
return None
from haystack.tracing.opentelemetry import OpenTelemetryTracer
return OpenTelemetryTracer(opentelemetry.trace.get_tracer("haystack"))
except ImportError:
pass
return None
def _auto_configured_datadog_tracer() -> Optional[Tracer]:
# we implement this here and not in the `datadog` module to avoid import warnings when Datadog is not installed
try:
from ddtrace import tracer
from haystack.tracing.datadog import DatadogTracer
if tracer.enabled:
return DatadogTracer(tracer=tracer)
except ImportError:
pass
return None
auto_enable_tracing()
|