1507788 - Can't add group names with "." in them to metrics.yaml

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P3)

Description

[Georg Fritzsche [:gfritzsche]]

I tried this from a test app integration and it fails.

Comment 1

[Michael Droettboom [:mdroettboom]]

There was some discussion I think '.' should be explicitly disallowed as it causes confusion.  Dot notation is used in a number of places on the backend to refer to metrics, and I think it would be confusing to have names like `A.B.C`.  Does that parse as 'A.B' + 'C' or 'A' + 'B.C'?  Where would I find the metric definition?  Since we've explicitly decided to have only two levels of hierarchy, I think it's important to be clear about that.

There was discussion of this in the SDK doc, and I believe it was decided to use snake case, but then this got removed when it was refactored to describe how metrics are grouped within the metrics.yaml file (i.e. category names are keys at the top level, not attributes of the individual metrics).

All that said, you probably got some inscrutable error message from jsonschema about this.  Those should be improved regardless of the decision on the above.

Comment 2

[Michael Droettboom [:mdroettboom]]

Attachment: GitHub Pull Request

Comment 3

[Michael Droettboom [:mdroettboom]]

Following discussion in meeting, I am moving forward with supporting dots in category names.

Comment 4

[Michael Droettboom [:mdroettboom]]

Attachment: GitHub Pull Request