Skip to content

docs(develop): update profile data categories from Relay#18578

Open
philipphofmann wants to merge 1 commit into
masterfrom
philipphofmann/docs/add-profile-data-categories
Open

docs(develop): update profile data categories from Relay#18578
philipphofmann wants to merge 1 commit into
masterfrom
philipphofmann/docs/add-profile-data-categories

Conversation

@philipphofmann

@philipphofmann philipphofmann commented Jun 29, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

While investigating getsentry/sentry-cocoa#8174, I noticed the develop-docs rate-limiting Definitions list was missing some profile data categories. This updates it to match Relay.

I only added the categories relevant for rate limiting (those that can appear in the X-Sentry-Rate-Limits header), not every profile category Relay defines. I'm not 100% sure I got the distinction right — someone from the Relay team should take a close look.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@vercel

vercel Bot commented Jun 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Jun 29, 2026 8:38am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Preview Jun 29, 2026 8:38am

Request Review

Bring the rate-limiting Definitions list in line with the profile data
categories that SDKs actually act on. The list predated Relay's profile
category split, so it was missing profile_chunk_ui, profile_backend, and
profile_ui. Also annotate each profile category with its SDK rate-limiting
behavior.

Only categories that can appear in the X-Sentry-Rate-Limits header are
listed. profile_duration and profile_duration_ui are excluded: despite
their 'apply to profile chunks' doc comment in data_category.rs, Relay's
EnvelopeLimiter has no CategoryLimit for them and never enforces them
against envelope items (they are billing/outcome categories). profile_indexed
is excluded as well since SDKs ignore it.

Surfaced while investigating a Cocoa profiling issue.

Refs getsentry/sentry-cocoa#8174
Co-Authored-By: Claude <noreply@anthropic.com>
@philipphofmann philipphofmann force-pushed the philipphofmann/docs/add-profile-data-categories branch from 6418c83 to ed8645b Compare June 29, 2026 08:31
@philipphofmann philipphofmann requested a review from Dav1dde June 29, 2026 08:35
@philipphofmann philipphofmann marked this pull request as ready for review June 29, 2026 08:35

@Dav1dde Dav1dde left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: SDKs can implement this probably very trivially by handling all categories the same, assuming an SDK never is backend and frontend at the same time. This means an SDK wouldn't need to know whether it is considered frontend or backend.

- `profile`: Profiling events
- `profile_chunk`: Continuous Profiling chunks
- `profile`: Profiling events (rate limiting: apply to all profiles).
- `profile_chunk`: Continuous Profiling chunks (rate limiting: apply to profile chunks).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are only backend profile chunks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants