Skip to content

feat(develop): Clean up contexts page structure #13206

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 1 commit into from
Apr 2, 2025
Merged

feat(develop): Clean up contexts page structure #13206

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
20 changes: 10 additions & 10 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 @@ -8,7 +8,7 @@ related to the current user and the environment. For example, the device or
application version. Its canonical name is `contexts`.

The `contexts` type can be used to define arbitrary contextual data on the
event. It accepts an object of key/value pairs. The key is the “alias” of the
event. It accepts an object of key/value pairs. The key is the "alias" of the
context and can be freely chosen. However, as per policy, it should match the
type of the context unless there are two values for a type. You can omit `type`
if the key name is the type.
Expand Down Expand Up @@ -273,7 +273,7 @@ To summarize:

: _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
**Example OS Context**

The OS Context for the 3 major OSs should look like this:

Expand Down Expand Up @@ -468,7 +468,7 @@ Examples: `"Apple Metal"` or `"Direct3D11"`

: _Optional_. Are geometry shaders available on the device?

### Example GPU Context
**Example GPU Context**

```json
{
Expand Down Expand Up @@ -496,7 +496,7 @@ The `type` and default key is `"state"`.

: **Required**. Object with two keys: _Optional_ `type` for naming the state library (e.g.: Redux, MobX, Vuex) and **Required** `value` that holds the state object.

### Example State Context
**Example State Context**

```json
{
Expand Down Expand Up @@ -598,7 +598,7 @@ The `type` and default key is `"cloud_resource"`.

- Example: `t4g.medium`

### Example Cloud Resource Context
**Example Cloud Resource Context**

The following example illustrates the contexts part of the <Link to="/sdk/data-model/event-payloads/">event payload</Link> and omits other attributes for simplicity.

Expand Down Expand Up @@ -720,7 +720,7 @@ The `route` currently supports the following predefined fields if it's a map:

If the route is set to a string (e.g. `"route": "foo"`), it will be normalized into a map (e.g. `"route": {"name": "foo"}`) server-side.

### Example Trace Context
**Example Trace Context**

```json
{
Expand Down Expand Up @@ -766,7 +766,7 @@ envelope endpoint.

: **Required**. The replay_id associated with the event.

### Example Replay Context
**Example Replay Context**

```json
{
Expand All @@ -792,7 +792,7 @@ This is mostly set on transactions in a web server environment where one transac

- Example: `200`

### Example Response Context
**Example Response Context**

```json
{
Expand Down Expand Up @@ -822,7 +822,7 @@ The required field is `package` which should contain the package or framework wh

- Example: `true`

### Example Response Context
**Example Response Context**

```json
{
Expand Down Expand Up @@ -852,7 +852,7 @@ The feature flag context contains information about the flags evaluated prior to
- Example: `false`


### Example Feature Flag Context
**Example Feature Flag Context**

```json
{
Expand Down