1976479 - Consider adding uploader_capabilities string list instrumentation to pings

Status: RESOLVED FIXED

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

Description

[Chris H-C :chutten|PTO (back Jan 5)]

Right now it's tough to validate that any given received ping was uploaded with any given combination of uploader_capabilities. On the client we have assurances (we know what was compiled in from pings.yaml and we know what was stored to disk), but once the ping leaves the client there's nothing about it that says one way or another.

It seems as though we should instrument the uploader_capabilities so that pings uploaded with them are annotated with them.

The fun piece might be figuring out where to put this instrumentation:

• ping_info feels like the right place, but some uploader_capabilities (notably ones that contain 'ohttp') require include_info_sections: false
• putting it in the payload: we'd have to be careful about timing it for when the ping is submitted in case the uploader_capabilities under which the ping was created do not match those when it gets handed to the uploader. This might make testing difficult when using test_before_next_submit.
• putting it in a header could be tricky to 1) make certain it's available in the data afterwards (I think metadata.headers would be straightforward to augment, but I've not done it before), and 2) make certain it's in the correct headers that'll make it through all the encode and decode steps that might be required for combinations of uploader_capabilities

Comment 1

[BMO Github Automation]

Attachment: [mozilla/glean] Bug 1976479 - Report a glean.ping.uploader_capabilities list in pings (#3188)

Comment 2

[Jan-Erik Rediger [:janerik] (Away until 2026-01-05)]

Attachment: data-review-1976479.md

Comment 3

[Travis Long [:travis_]]

Comment on attachment 9502690 [details]
data-review-1976479.md

Data Review Form (to be filled by Data Stewards)

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?

• Yes, via the Glean Dictionary

2. Is there a control mechanism that allows the user to turn the data collection on and off?

• Yes, the application settings provide data collection opt-out choices.

3. If the request is for permanent data collection, is there someone who will monitor the data over time?

• Permanent collection to be monitored by Jan-Erik, backed by [e-mail]

4. Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?

• Category 1 - Technical

5. Is the data collection request for default-on or default-off?

• default on

6. Does the instrumentation include the addition of any new identifiers (whether anonymous or otherwise; e.g., username, random IDs, etc.

• No

7. Is the data collection covered by the existing Firefox privacy notice?

• Yes

8. Does the data collection use a third-party collection tool?

• No

Result

data-review+

Comment 4

[Jan-Erik Rediger [:janerik] (Away until 2026-01-05)]

badboy merged PR [mozilla/glean]: Bug 1976479 - Report a glean.ping.uploader_capabilities list in pings (#3188) in c18fb12.