Closed Bug 1566854 Opened 6 years ago Closed 6 years ago

Document each metric type's JSON payload

Categories

(Data Platform and Tools :: Glean: SDK, enhancement, P1)

enhancement

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: mdroettboom, Assigned: janerik)

Details

(Whiteboard: [telemetry:glean-rs:m6])

Attachments

(1 file)

We should document the format of each metric type in the ping payload. This currently only exists in the JSON schema, which is not exactly user friendly to those unfamiliar with JSON schema.

I would argue this should include even simple one-line descriptions for the basic metric types (boolean, string, etc.). Datetime could really use some docs about the exact subset of ISO8601 that could be expected, etc.

We have separate bugs for the complicated ones: events and timing distributions.

Assignee: nobody → jrediger
Type: defect → enhancement
Priority: P3 → P1
Whiteboard: [telemetry:glean-rs:m?] → [telemetry:glean-rs:m6]
Attached file GitHub Pull Request
Status: NEW → RESOLVED
Closed: 6 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: