Skip to content

docs(profiling): Fix missing platform item header for profile_chunk #16135

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
s1gr1d merged 2 commits into from
Jan 23, 2026
Merged

docs(profiling): Fix missing platform item header for profile_chunk #16135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c89710b
docs(profiling): Fix missing `platform` item header for `profile_chunk`
s1gr1d Jan 23, 2026
0916983
add info about platform matching
s1gr1d Jan 23, 2026
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
4 changes: 3 additions & 1 deletion develop-docs/sdk/data-model/envelope-items.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,9 @@ _None_

**Additional Item Headers:**

_None_
`platform`

: **String, required.** The platform of the profiled application. This item header is used for rate limiting and categorization. It must match the `platform` in the payload. the Examples: `"javascript"`, `"node"`, `"python"`, `"cocoa"`, etc.

### Check-Ins

Expand Down
8 changes: 3 additions & 5 deletions develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,17 +280,15 @@ It's suggested to remove unnecessary data like thread data without samples from

## Ingestion

After this payload is generated, serialize it as JSON, pack it into an
After this payload is generated, serialize it as JSON, pack it into an [Envelope](/sdk/data-model/envelopes/) with the item type [`profile_chunk`](/sdk/data-model/envelope-items/#profile-chunk) and send it to Relay.

[Envelope](/sdk/data-model/envelopes/) with the item type [`profile_chunk`](/sdk/data-model/envelope-items/#profile-chunk) and send

it to Relay.
The `platform` item header is required for rate limiting and categorization of the profile chunk and must match the `platform` in the payload.

This envelope should look like this:

```json
{"event_id":"a229377b82ad4898be7c3a6272d052d9"}
{"type":"profile_chunk"}
{"type":"profile_chunk", "platform":"node"}
{ /* profile_chunk JSON payload */}
````

Expand Down