|
| 1 | +from typing import Any, Dict, Generator, List, Literal, Optional, Union |
| 2 | + |
| 3 | +from opentelemetry import baggage |
| 4 | +from opentelemetry import ( |
| 5 | + baggage as otel_baggage_api, |
| 6 | +) |
| 7 | +from opentelemetry import ( |
| 8 | + context as otel_context_api, |
| 9 | +) |
| 10 | +from opentelemetry import ( |
| 11 | + trace as otel_trace_api, |
| 12 | +) |
| 13 | +from opentelemetry.util._decorator import _agnosticcontextmanager |
| 14 | + |
| 15 | +from langfuse._client.attributes import LangfuseOtelSpanAttributes |
| 16 | +from langfuse.logger import langfuse_logger |
| 17 | + |
| 18 | +PropagatedKeys = Literal["user_id", "session_id", "metadata"] |
| 19 | + |
| 20 | + |
| 21 | +@_agnosticcontextmanager |
| 22 | +def propagate_attributes( |
| 23 | + *, |
| 24 | + user_id: Optional[str] = None, |
| 25 | + session_id: Optional[str] = None, |
| 26 | + metadata: Optional[Dict[str, str]] = None, |
| 27 | + as_baggage: bool = False, |
| 28 | +) -> Generator[Any, Any, Any]: |
| 29 | + context = otel_context_api.get_current() |
| 30 | + current_span = otel_trace_api.get_current_span() |
| 31 | + |
| 32 | + if user_id is not None: |
| 33 | + context = _set_propagated_attribute( |
| 34 | + key="user_id", |
| 35 | + value=user_id, |
| 36 | + context=context, |
| 37 | + span=current_span, |
| 38 | + as_baggage=as_baggage, |
| 39 | + ) |
| 40 | + |
| 41 | + if session_id is not None: |
| 42 | + context = _set_propagated_attribute( |
| 43 | + key="session_id", |
| 44 | + value=session_id, |
| 45 | + context=context, |
| 46 | + span=current_span, |
| 47 | + as_baggage=as_baggage, |
| 48 | + ) |
| 49 | + |
| 50 | + if metadata is not None: |
| 51 | + context = _set_propagated_attribute( |
| 52 | + key="metadata", |
| 53 | + value=_validate_propagated_metadata(metadata), |
| 54 | + context=context, |
| 55 | + span=current_span, |
| 56 | + as_baggage=as_baggage, |
| 57 | + ) |
| 58 | + |
| 59 | + # Activate context, execute, and detach context |
| 60 | + token = otel_context_api.attach(context=context) |
| 61 | + |
| 62 | + try: |
| 63 | + yield |
| 64 | + |
| 65 | + finally: |
| 66 | + otel_context_api.detach(token) |
| 67 | + |
| 68 | + |
| 69 | +def _get_propagated_attributes_from_context( |
| 70 | + context: otel_context_api.Context, |
| 71 | +) -> Dict[str, str]: |
| 72 | + propagated_attributes: Dict[str, str] = {} |
| 73 | + |
| 74 | + # Handle baggage |
| 75 | + baggage_entries = baggage.get_all(context=context) |
| 76 | + for baggage_key, baggage_value in baggage_entries.items(): |
| 77 | + if baggage_key.startswith(LANGFUSE_BAGGAGE_PREFIX): |
| 78 | + span_key = _get_span_key_from_baggage_key(baggage_key) |
| 79 | + |
| 80 | + if span_key: |
| 81 | + propagated_attributes[span_key] = str(baggage_value) |
| 82 | + |
| 83 | + # Handle OTEL context |
| 84 | + propagated_keys: List[PropagatedKeys] = ["user_id", "session_id", "metadata"] |
| 85 | + |
| 86 | + for key in propagated_keys: |
| 87 | + context_key = _get_propagated_context_key(key) |
| 88 | + value = otel_context_api.get_value(key=context_key, context=context) |
| 89 | + |
| 90 | + if isinstance(value, dict): |
| 91 | + # Handle metadata |
| 92 | + for k, v in value.items(): |
| 93 | + span_key = f"{LangfuseOtelSpanAttributes.TRACE_METADATA}.{k}" |
| 94 | + propagated_attributes[span_key] = v |
| 95 | + |
| 96 | + else: |
| 97 | + span_key = { |
| 98 | + "user_id": LangfuseOtelSpanAttributes.TRACE_USER_ID, |
| 99 | + "session_id": LangfuseOtelSpanAttributes.TRACE_SESSION_ID, |
| 100 | + }.get(key, f"{LangfuseOtelSpanAttributes.TRACE_METADATA}.{key}") |
| 101 | + |
| 102 | + propagated_attributes[span_key] = str(value) |
| 103 | + |
| 104 | + return propagated_attributes |
| 105 | + |
| 106 | + |
| 107 | +def _set_propagated_attribute( |
| 108 | + *, |
| 109 | + key: PropagatedKeys, |
| 110 | + value: Union[str, Dict[str, str]], |
| 111 | + context: otel_context_api.Context, |
| 112 | + span: otel_trace_api.Span, |
| 113 | + as_baggage: bool, |
| 114 | +) -> otel_context_api.Context: |
| 115 | + # Get key names |
| 116 | + context_key = _get_propagated_context_key(key) |
| 117 | + span_key = _get_propagated_span_key(key) |
| 118 | + baggage_key = _get_propagated_baggage_key(key) |
| 119 | + |
| 120 | + # Set in context |
| 121 | + context = otel_context_api.set_value( |
| 122 | + key=context_key, |
| 123 | + value=value, |
| 124 | + context=context, |
| 125 | + ) |
| 126 | + |
| 127 | + # Set on current span |
| 128 | + if span is not None and span.is_recording(): |
| 129 | + if isinstance(value, dict): |
| 130 | + # Handle metadata |
| 131 | + for k, v in value.items(): |
| 132 | + span.set_attribute( |
| 133 | + key=f"{LangfuseOtelSpanAttributes.TRACE_METADATA}.{k}", |
| 134 | + value=v, |
| 135 | + ) |
| 136 | + |
| 137 | + else: |
| 138 | + span.set_attribute(key=span_key, value=value) |
| 139 | + |
| 140 | + # Set on baggage |
| 141 | + if as_baggage: |
| 142 | + if isinstance(value, dict): |
| 143 | + # Handle metadata |
| 144 | + for k, v in value.items(): |
| 145 | + context = otel_baggage_api.set_baggage( |
| 146 | + name=f"{baggage_key}_{k}", value=v, context=context |
| 147 | + ) |
| 148 | + else: |
| 149 | + context = otel_baggage_api.set_baggage( |
| 150 | + name=baggage_key, value=value, context=context |
| 151 | + ) |
| 152 | + |
| 153 | + return context |
| 154 | + |
| 155 | + |
| 156 | +def _validate_propagated_metadata(metadata: Dict[str, str]) -> Dict[str, str]: |
| 157 | + validated_metadata: Dict[str, str] = {} |
| 158 | + |
| 159 | + for key, value in metadata.items(): |
| 160 | + if not isinstance(value, str): |
| 161 | + langfuse_logger.warning( # type: ignore |
| 162 | + f"Propagated attribute value of '{key}' not a string. Dropping value." |
| 163 | + ) |
| 164 | + continue |
| 165 | + |
| 166 | + if len(value) > 200: |
| 167 | + langfuse_logger.warning( |
| 168 | + f"Propagated attribute value of '{key}' is over 200 characters ({len(value)} chars). Dropping value." |
| 169 | + ) |
| 170 | + continue |
| 171 | + |
| 172 | + validated_metadata[key] = value |
| 173 | + |
| 174 | + return validated_metadata |
| 175 | + |
| 176 | + |
| 177 | +def _get_propagated_context_key(key: PropagatedKeys) -> str: |
| 178 | + return f"langfuse.propagated.{key}" |
| 179 | + |
| 180 | + |
| 181 | +LANGFUSE_BAGGAGE_PREFIX = "langfuse_" |
| 182 | + |
| 183 | + |
| 184 | +def _get_propagated_baggage_key(key: PropagatedKeys) -> str: |
| 185 | + return f"{LANGFUSE_BAGGAGE_PREFIX}{key}" |
| 186 | + |
| 187 | + |
| 188 | +def _get_span_key_from_baggage_key(key: str) -> Optional[str]: |
| 189 | + if not key.startswith(LANGFUSE_BAGGAGE_PREFIX): |
| 190 | + return None |
| 191 | + |
| 192 | + if "user_id" in key: |
| 193 | + return LangfuseOtelSpanAttributes.TRACE_USER_ID |
| 194 | + |
| 195 | + if "session_id" in key: |
| 196 | + return LangfuseOtelSpanAttributes.TRACE_SESSION_ID |
| 197 | + |
| 198 | + return f"{LangfuseOtelSpanAttributes.TRACE_METADATA}.{key}" |
| 199 | + |
| 200 | + |
| 201 | +def _get_propagated_span_key(key: PropagatedKeys) -> str: |
| 202 | + return { |
| 203 | + "session_id": LangfuseOtelSpanAttributes.TRACE_SESSION_ID, |
| 204 | + "user_id": LangfuseOtelSpanAttributes.TRACE_USER_ID, |
| 205 | + }.get(key) or f"{LangfuseOtelSpanAttributes.TRACE_METADATA}.{key}" |
0 commit comments