Skip to content

Commit 1e1e202

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 bf11ec1 commit 1e1e202

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
@@ -552,17 +552,25 @@ def _process_media_and_apply_mask(
552552
The processed and masked data
553553
"""
554554
return self._mask_attribute(
555-
data=self._process_media_in_attribute(data=data, field=field)
555+
data=self._process_media_in_attribute(data=data, field=field), field=field
556556
)
557557

558-
def _mask_attribute(self, *, data: Any) -> Any:
558+
def _mask_attribute(
559+
self,
560+
*,
561+
data: Any,
562+
field: Optional[
563+
Union[Literal["input"], Literal["output"], Literal["metadata"]]
564+
] = None,
565+
) -> Any:
559566
"""Apply the configured mask function to data.
560567
561568
Internal method that applies the client's configured masking function to
562569
the provided data, with error handling and fallback.
563570
564571
Args:
565572
data: The data to mask
573+
field: The attribute the data belongs to
566574
567575
Returns:
568576
The masked data, or the original data if no mask is configured
@@ -578,8 +586,14 @@ def _mask_attribute(self, *, data: Any) -> Any:
578586
"data. Using fallback masking. Error: %s",
579587
e,
580588
)
589+
fallback = "<fully masked due to failed mask function>"
590+
591+
# Dict metadata is written per key, so mask each key instead of
592+
# writing a plain string to the bare metadata attribute
593+
if field == "metadata" and isinstance(data, dict):
594+
return {key: fallback for key in data}
581595

582-
return "<fully masked due to failed mask function>"
596+
return fallback
583597

584598
def _process_media_in_attribute(
585599
self,

‎tests/unit/test_otel.py‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1986,6 +1986,89 @@ def update_random_metadata(thread_id):
19861986
assert "version" in system_data
19871987
assert "features" in system_data
19881988

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

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

0 commit comments

Comments
 (0)