Skip to content

Commit

Permalink
(docs): update untagged telemetry safeness statement (#22561)
Browse files Browse the repository at this point in the history
Currently, there's an ongoing issue where untagged telemtry logs is
producing HTML reponse with PII.
https://dev.azure.com/fluidframework/internal/_workitems/edit/14286
Until further investigation, updating docs to not explicitly state
untagged telemtry is safe for logging.
  • Loading branch information
zhenmichael authored Sep 18, 2024
1 parent 8987bc9 commit 30a455a
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/content/docs/testing/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,7 @@ either tagged (`ITaggedTelemetryPropertyType`) or untagged (`TelemetryEventPrope

### Understanding Tags

Tags are strings used to classify the properties on telemetry events. By default, telemetry properties are untagged
and untagged properties can be considered safe for general logging. However,
Tags are strings used to classify the properties on telemetry events. By default, telemetry properties are untagged. However,
the Fluid Framework may emit events with some properties tagged, so implementations of `ITelemetryBaseLogger` must be
prepared to check for and interpret any tags. Generally speaking, when logging to the user's console, tags can
be ignored and tagged values logged plainly, but when transmitting tagged properties to a telemetry service,
Expand Down

0 comments on commit 30a455a

Please sign in to comment.