1779003 - Event docs suggest extra values are limited to 50B... or 100B, depending on where you look

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, defect, P2)

Description

[Chris H-C :chutten]

Under record(map)'s recorded errors:

invalid_overflow: if any of the values in the extras object are greater than 50 bytes in length. (Prior to Glean 31.5.0, this recorded an invalid_value).

Under Limits

The values in the extras object have a maximum length of 100 bytes, when serialized and encoded as UTF-8.

Also: Do we truncate? Other string types confirm we truncate and record an error, but event is silent on that front.

Also also: Are the recorded errors just for record(map) or for both old and new record APIs?

Comment 1

[Jan-Erik Rediger [:janerik]]

100 is correct as per the code: https://github.com/mozilla/glean/blob/2cc2c2747673e753c8bf23b04560a992a1f16ef0/glean-core/src/metrics/event.rs#L14
We truncate and record an error: https://github.com/mozilla/glean/blob/2cc2c2747673e753c8bf23b04560a992a1f16ef0/glean-core/src/metrics/event.rs#L93-L99
This holds for both APIs.

Comment 2

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/glean/pull/2127

Comment 3

[Chris H-C :chutten]

chutten merged PR #2127: "bug 1779003 - Consistently note event extra value length limit of 100B [doc only]" in 9630931.