1339195 - Add explicit documentation on "extra" field format type for event telemetry

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect, P1)

Description

[bugzilla]

I noticed we do an undocumented check in the telemetry client to ensure that the "extra" object is a simple json object of string keys + string values (https://hg.mozilla.org/integration/mozilla-inbound/rev/190f6fc837b5#l4.495). My life would be so much easier on the ETL side if I can assume this is true and throw out any values that don't conform.

Can we document this officially so I can throw out values that aren't Strings as non-conforming to spec?

Comment 1

[Georg Fritzsche [:gfritzsche]]

(In reply to Sunah Suh [:sunahsuh] from comment #0)
> Can we document this officially so I can throw out values that aren't
> Strings as non-conforming to spec?

Sure - this was part of the draft, i'll call this out explicitly in the docs.

Comment 2

[Georg Fritzsche [:gfritzsche]]

Attachment: Clearly document event extra fields requiring string keys and values

Comment 3

[Alessio Placitelli [:Dexter]]

Comment on attachment 8865773 [details] [diff] [review]
Clearly document event extra fields requiring string keys and values

Review of attachment 8865773 [details] [diff] [review]:
-----------------------------------------------------------------

We should also enforce that in the schema if it's not like that, already.

Comment 4

[Georg Fritzsche [:gfritzsche]]

Not yet:
https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/main/main.4.schema.json#L861

We should restrict this using some variant of:
> "additionalProperties": { "type": "string" }

Comment 5

[Alessio Placitelli [:Dexter]]

Maybe we can piggyback this change on https://github.com/mozilla-services/mozilla-pipeline-schemas/pull/34 ? Please comment there if you think it would be useful (so that we can test it only once, as testing schemas server side is still very painful :D ).

Comment 6

[Georg Fritzsche [:gfritzsche]]

I've opened a PR: https://github.com/mozilla-services/mozilla-pipeline-schemas/pull/45

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/e69c90207160
Clearly document event extra fields requiring string keys and values. r=Dexter

Comment 8

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/e69c90207160