Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add possible values for normalized_channel and normalized_os fields #859

Merged
merged 1 commit into from
Feb 13, 2025
Merged

Add possible values for normalized_channel and normalized_os fields #859

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions src/cookbooks/new_ping_metadata_table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
| field | description |
| -------------------------------------- | ------------------------------------------------------------------------------------- |
| `additional_properties` | A JSON string containing any payload properties not present in the schema |
| `document_id` | The document ID specified in the URI when the client sent this message |
| `normalized_app_name` | Set to "Other" if this message contained an unrecognized app name |
| `normalized_channel` | Set to "Other" if this message contained an unrecognized channel name |
| `normalized_country_code` | An ISO 3166-1 alpha-2 country code |
| `normalized_os` | Set to "Other" if this message contained an unrecognized OS name |
| `normalized_os_version` | N/A |
| `sample_id` | Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 |
| `submission_timestamp` | Time when the ingestion edge server accepted this message |
| `metadata.user_agent.browser` | N/A |
| `metadata.user_agent.os` | N/A |
| `metadata.user_agent.version` | N/A |
| `metadata.uri.app_build_id` | N/A |
| `metadata.uri.app_name` | N/A |
| `metadata.uri.app_update_channel` | N/A |
| `metadata.uri.app_version` | N/A |
| `metadata.header.date` | Date HTTP header |
| `metadata.header.dnt` | DNT (Do Not Track) HTTP header |
| `metadata.header.x_debug_id` | X-Debug-Id HTTP header |
| `metadata.header.x_pingsender_version` | X-PingSender-Version HTTP header |
| `metadata.geo.city` | City name |
| `metadata.geo.country` | An ISO 3166-1 alpha-2 country code |
| `metadata.geo.db_version` | The specific [Geo database] version used for this lookup |
| `metadata.geo.subdivision1` | First major country subdivision, typically a state, province, or county |
| `metadata.geo.subdivision2` | Second major country subdivision; not applicable for most countries |
| `metadata.isp.db_version` | The specific [ISP database] version used for this lookup |
| `metadata.isp.name` | The name of the Internet Service Provider |
| `metadata.isp.organization` | The name of a specific business entity when available; otherwise the ISP name |
| field | description |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `additional_properties` | A JSON string containing any payload properties not present in the schema |
| `document_id` | The document ID specified in the URI when the client sent this message |
| `normalized_app_name` | Set to "Other" if this message contained an unrecognized app name |
| `normalized_channel` | Possible values: `release`, `esr`, `beta`, `aurora`, `nightly`, or `Other` when this message contained an unrecognized channel name |
| `normalized_country_code` | An ISO 3166-1 alpha-2 country code |
| `normalized_os` | Possible values: `Windows`, `Mac`, `Linux`, `iOS`, `Android`, or `Other` when this message contained an unrecognized OS name |
| `normalized_os_version` | N/A |
| `sample_id` | Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 |
| `submission_timestamp` | Time when the ingestion edge server accepted this message |
| `metadata.user_agent.browser` | N/A |
| `metadata.user_agent.os` | N/A |
| `metadata.user_agent.version` | N/A |
| `metadata.uri.app_build_id` | N/A |
| `metadata.uri.app_name` | N/A |
| `metadata.uri.app_update_channel` | N/A |
| `metadata.uri.app_version` | N/A |
| `metadata.header.date` | Date HTTP header |
| `metadata.header.dnt` | DNT (Do Not Track) HTTP header |
| `metadata.header.x_debug_id` | X-Debug-Id HTTP header |
| `metadata.header.x_pingsender_version` | X-PingSender-Version HTTP header |
| `metadata.geo.city` | City name |
| `metadata.geo.country` | An ISO 3166-1 alpha-2 country code |
| `metadata.geo.db_version` | The specific [Geo database] version used for this lookup |
| `metadata.geo.subdivision1` | First major country subdivision, typically a state, province, or county |
| `metadata.geo.subdivision2` | Second major country subdivision; not applicable for most countries |
| `metadata.isp.db_version` | The specific [ISP database] version used for this lookup |
| `metadata.isp.name` | The name of the Internet Service Provider |
| `metadata.isp.organization` | The name of a specific business entity when available; otherwise the ISP name |

[geo database]: https://dev.maxmind.com/geoip/geoip2/geoip2-city-country-csv-databases/
[isp database]: https://dev.maxmind.com/geoip/geoip2/geoip2-isp-csv-database/
Loading