Skip to content

Commit 47d263b

Browse files
niklassemmlerclaude
andcommitted
fix(tracing): mask metadata per key when the mask function fails
When a custom mask function raised on dict metadata, the fallback string was written to the bare langfuse.observation.metadata attribute. The server parses that attribute as a JSON object, so the fallback was lost, and nothing showed which keys had been masked. For dict metadata, write the fallback under each key of the failed call instead, so it merges with keys from earlier updates like any other update. Non-dict metadata, input and output keep the plain-string fallback. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent 6d8c760 commit 47d263b

2 files changed

Lines changed: 100 additions & 3 deletions

File tree

‎langfuse/_client/span.py‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -504,17 +504,25 @@ def _process_media_and_apply_mask(
504504
The processed and masked data
505505
"""
506506
return self._mask_attribute(
507-
data=self._process_media_in_attribute(data=data, field=field)
507+
data=self._process_media_in_attribute(data=data, field=field), field=field
508508
)
509509

510-
def _mask_attribute(self, *, data: Any) -> Any:
510+
def _mask_attribute(
511+
self,
512+
*,
513+
data: Any,
514+
field: Optional[
515+
Union[Literal["input"], Literal["output"], Literal["metadata"]]
516+
] = None,
517+
) -> Any:
511518
"""Apply the configured mask function to data.
512519
513520
Internal method that applies the client's configured masking function to
514521
the provided data, with error handling and fallback.
515522
516523
Args:
517524
data: The data to mask
525+
field: The attribute the data belongs to
518526
519527
Returns:
520528
The masked data, or the original data if no mask is configured
@@ -530,8 +538,14 @@ def _mask_attribute(self, *, data: Any) -> Any:
530538
"data. Using fallback masking. Error: %s",
531539
e,
532540
)
541+
fallback = "<fully masked due to failed mask function>"
542+
543+
# Dict metadata is written per key, so mask each key instead of
544+
# writing a plain string to the bare metadata attribute
545+
if field == "metadata" and isinstance(data, dict):
546+
return {key: fallback for key in data}
533547

534-
return "<fully masked due to failed mask function>"
548+
return fallback
535549

536550
def _process_media_in_attribute(
537551
self,

‎tests/unit/test_otel.py‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1980,6 +1980,89 @@ def update_random_metadata(thread_id):
19801980
assert "version" in system_data
19811981
assert "features" in system_data
19821982

1983+
MASK_FALLBACK = "<fully masked due to failed mask function>"
1984+
1985+
def get_metadata_attributes(self, span_data: dict) -> dict:
1986+
prefix = LangfuseOtelSpanAttributes.OBSERVATION_METADATA
1987+
return {
1988+
key: value
1989+
for key, value in span_data["attributes"].items()
1990+
if key == prefix or key.startswith(f"{prefix}.")
1991+
}
1992+
1993+
def test_failed_mask_on_update_masks_each_metadata_key(
1994+
self, configurable_langfuse_client, memory_exporter
1995+
):
1996+
def mask(*, data, **kwargs):
1997+
if isinstance(data, dict) and "secret" in data:
1998+
raise ValueError("mask failed")
1999+
return data
2000+
2001+
langfuse_client = configurable_langfuse_client(mask=mask)
2002+
span = langfuse_client.start_observation(name="mask-fail", metadata={"a": 1})
2003+
span.update(metadata={"secret": "pw", "b": 2})
2004+
span.end()
2005+
2006+
span_data = self.get_spans_by_name(memory_exporter, "mask-fail")[0]
2007+
prefix = LangfuseOtelSpanAttributes.OBSERVATION_METADATA
2008+
assert self.get_metadata_attributes(span_data) == {
2009+
f"{prefix}.a": 1,
2010+
f"{prefix}.secret": self.MASK_FALLBACK,
2011+
f"{prefix}.b": self.MASK_FALLBACK,
2012+
}
2013+
2014+
def test_failed_mask_on_start_masks_each_metadata_key(
2015+
self, configurable_langfuse_client, memory_exporter
2016+
):
2017+
def mask(*, data, **kwargs):
2018+
if isinstance(data, dict):
2019+
raise ValueError("mask failed")
2020+
return data
2021+
2022+
langfuse_client = configurable_langfuse_client(mask=mask)
2023+
span = langfuse_client.start_observation(
2024+
name="mask-fail-start", metadata={"secret": "pw", "b": 2}
2025+
)
2026+
span.end()
2027+
2028+
span_data = self.get_spans_by_name(memory_exporter, "mask-fail-start")[0]
2029+
prefix = LangfuseOtelSpanAttributes.OBSERVATION_METADATA
2030+
assert self.get_metadata_attributes(span_data) == {
2031+
f"{prefix}.secret": self.MASK_FALLBACK,
2032+
f"{prefix}.b": self.MASK_FALLBACK,
2033+
}
2034+
2035+
def test_failed_mask_keeps_string_fallback_for_non_dict_values(
2036+
self, configurable_langfuse_client, memory_exporter
2037+
):
2038+
def mask(*, data, **kwargs):
2039+
if data is not None:
2040+
raise ValueError("mask failed")
2041+
return data
2042+
2043+
langfuse_client = configurable_langfuse_client(mask=mask)
2044+
span = langfuse_client.start_observation(
2045+
name="mask-fail-non-dict",
2046+
input={"secret": "pw"},
2047+
output={"secret": "pw"},
2048+
metadata="plain-string",
2049+
)
2050+
span.end()
2051+
2052+
span_data = self.get_spans_by_name(memory_exporter, "mask-fail-non-dict")[0]
2053+
attributes = span_data["attributes"]
2054+
assert self.get_metadata_attributes(span_data) == {
2055+
LangfuseOtelSpanAttributes.OBSERVATION_METADATA: self.MASK_FALLBACK,
2056+
}
2057+
assert (
2058+
attributes[LangfuseOtelSpanAttributes.OBSERVATION_INPUT]
2059+
== self.MASK_FALLBACK
2060+
)
2061+
assert (
2062+
attributes[LangfuseOtelSpanAttributes.OBSERVATION_OUTPUT]
2063+
== self.MASK_FALLBACK
2064+
)
2065+
19832066

19842067
class TestMultiProjectSetup(TestOTelBase):
19852068
"""Tests for multi-project setup within the same process.

0 commit comments

Comments
 (0)