1655126 - Limits of metric fields are documented in spread-out places

Status: RESOLVED WONTFIX

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

Description

[Chris H-C :chutten]

In writing about the differences between Telemetry and the Glean SDK (see bug 1651104) I had difficulty figuring out what the limits are in string length and accepted character patterns for various parts of metrics definitions and APIs.

For example, to learn about metric category and name limits I need to look at https://mozilla.github.io/glean_parser/metrics-yaml.html

But to find out about Labels in Labeled Booleans I needed to find the format here the phrase "maximum of 60 bytes, when encoded as UTF8" from here and the number of labels able to be specified in the metrics.yaml from here

(( also, I just noticed that the label pattern as documented will forbid a.very_unbalanced_but_shorter_than_60_label. AND the maximum length is actually 71 in the schema. So, uh, yeah. ))

I'm not sure if my use case is a meaningful one to organize around, but at least the factual inaccuracies and omissions about labels should be addressed.

And I have an inkling that users might want to go from choosing a metric type to that metric type's documentation to wanting to type in the YAML right away. And without a full list of limits in Limits and a full example definition in Configuration... it'll be tricky.

Comment 1

[Travis Long [:travis_]]

Closing this as stale