Skip to content

feat(native): update contexts interface to flatten distribution keys #11936

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

Merged
merged 3 commits into from
Dec 4, 2024
Merged

feat(native): update contexts interface to flatten distribution keys #11936

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2561bd4
Updated distribution keys to flattened versions
JoshuaMoelans Nov 25, 2024
f550f08
link to native main branch + os-release dos
JoshuaMoelans Dec 4, 2024
6f4564d
Change links to relevant Options entry
JoshuaMoelans Dec 4, 2024
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
20 changes: 11 additions & 9 deletions develop-docs/sdk/data-model/event-payloads/contexts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,14 +261,17 @@ To summarize:

: _Optional_. An unprocessed description string obtained by the operating system. For some well-known runtimes, Sentry will attempt to parse `name` and `version` from this string, if they are not explicitly given.

`distribution`
`distribution_name`

: _Optional_. An object that provides meta-data for Linux distributions. The values correspond to entries from the [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#Options) configuration. Contains the following keys:
: _Optional_. A stable name for each distribution. This maps to `ID` in [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#ID=) (examples: `ubuntu`, `rhel`, `alpine`; a full list of tested identifiers is available in the [Native SDK repository](https://github.com/getsentry/sentry-native/blob/master/tests/fixtures/os_releases/distribution_names.txt))

`distribution_version`

- `name`: A stable name for each distribution. This maps to `ID` in `/etc/os-release` (examples: `ubuntu`, `rhel`, `alpine`; a full list of tested identifiers is available in the [Native SDK repository](https://github.com/getsentry/sentry-native/blob/feat/add_linux_distros_to_os_context/tests/fixtures/os_releases/distribution_names.txt).
- `version`: _Optional_. Typically identifies at least the major release version number. This maps to `VERSION_ID` in `/etc/os-release`. Distributions with rolling releases only, will not provide a version.
- `pretty_name`: _Optional_. Typically provides the full name, full version, and release alias. This maps to `PRETTY_NAME` in `/etc/os-release` (examples: `Ubuntu 22.04.4 LTS`, `Raspian GNU/Linux 10 (buster)`).
: _Optional_. Typically identifies at least the major release version number. This maps to `VERSION_ID` in [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#VERSION_ID=). Distributions with rolling releases only, will not provide a version.

`distribution_pretty_name`

: _Optional_. Typically provides the full name, full version, and release alias. This maps to `PRETTY_NAME` in [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#PRETTY_NAME=) (examples: `Ubuntu 22.04.4 LTS`, `Raspian GNU/Linux 10 (buster)`).

### Example OS Context

Expand All @@ -293,10 +296,9 @@ The OS Context for the 3 major OSs should look like this:
"type": "os",
"name": "Linux",
"version": "6.1.82(99.168.amzn2023.x86_64)",
"distribution": {
"name": "amzn",
"version": "2023",
"pretty_name": "Amazon Linux 2023.4.20240401"
"distribution_name": "amzn",
"distribution_version": "2023",
"distribution_pretty_name": "Amazon Linux 2023.4.20240401"
}
}
}
Expand Down
Loading