docs(develop): update profile data categories from Relay#18578
docs(develop): update profile data categories from Relay#18578philipphofmann wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
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
force-pushed
the
philipphofmann/docs/add-profile-data-categories
branch
from
6418c83 to
ed8645b
Compare
Dav1dde
left a comment
Dav1dde
left a comment
There was a problem hiding this comment.
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). |
There was a problem hiding this comment.
These are only backend profile chunks
@Dav1dde I wonder why Relay even communicates these data categories. Why isn't there only one profile data category? Is my assumption correct, so it can apply different rate limits for different types of profiling? |
2 participants
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-Limitsheader), 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.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: