From c89710bff2469bde32109845dc67f369d55cadcc Mon Sep 17 00:00:00 2001 From: s1gr1d <32902192+s1gr1d@users.noreply.github.com> Date: Fri, 23 Jan 2026 12:20:10 +0100 Subject: [PATCH 1/2] docs(profiling): Fix missing `platform` item header for `profile_chunk` --- develop-docs/sdk/data-model/envelope-items.mdx | 4 +++- develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/develop-docs/sdk/data-model/envelope-items.mdx b/develop-docs/sdk/data-model/envelope-items.mdx index 4c466e05bf463..76b7bb7d399cd 100644 --- a/develop-docs/sdk/data-model/envelope-items.mdx +++ b/develop-docs/sdk/data-model/envelope-items.mdx @@ -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. Examples: `"javascript"`, `"node"`, `"python"`, `"cocoa"`, etc. ### Check-Ins diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx index 26c176534e584..743467a635e3b 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx @@ -284,13 +284,13 @@ 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. +it to Relay. The `platform` item header is required for rate limiting and categorization of the profile chunk. This envelope should look like this: ```json {"event_id":"a229377b82ad4898be7c3a6272d052d9"} -{"type":"profile_chunk"} +{"type":"profile_chunk", "platform":"node"} { /* profile_chunk JSON payload */} ```` From 091698384e11c3cf7035d6a99e3fa2d790666db9 Mon Sep 17 00:00:00 2001 From: s1gr1d <32902192+s1gr1d@users.noreply.github.com> Date: Fri, 23 Jan 2026 12:59:56 +0100 Subject: [PATCH 2/2] add info about platform matching --- develop-docs/sdk/data-model/envelope-items.mdx | 2 +- develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx | 6 ++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/develop-docs/sdk/data-model/envelope-items.mdx b/develop-docs/sdk/data-model/envelope-items.mdx index 76b7bb7d399cd..ddb990ff2dd07 100644 --- a/develop-docs/sdk/data-model/envelope-items.mdx +++ b/develop-docs/sdk/data-model/envelope-items.mdx @@ -432,7 +432,7 @@ _None_ `platform` -: **String, required.** The platform of the profiled application. This item header is used for rate limiting and categorization. Examples: `"javascript"`, `"node"`, `"python"`, `"cocoa"`, etc. +: **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 diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx index 743467a635e3b..cc0fa464dc379 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx @@ -280,11 +280,9 @@ 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. +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: