fix(telemetry-processor): Clarify push-based vs pull-based#16653
fix(telemetry-processor): Clarify push-based vs pull-based#16653philipphofmann wants to merge 5 commits intoref/telemetry-processor-dedupe-archfrom
Conversation
… approach Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
giortzisg
left a comment
There was a problem hiding this comment.
Looks good, left some minor comments
develop-docs/sdk/foundations/processing/telemetry-processor/backend-telemetry-processor.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| ## Push-Based Approach | ||
|
|
||
| SDKs **SHOULD** use the push-based approach, where the telemetry buffers push data to the telemetry scheduler when full or on timeout. For high-throughput scenarios, SDKs **MAY** use a [pull-based alternative](./backend-telemetry-processor/) optimized for backends, where the scheduler pulls items from the buffers. |
There was a problem hiding this comment.
I am torn between creating a pull-based approach section on the index page or just have it only on the backend page to avoid duplication. However even if we keep it as is, let's add a section for the pull-based approach so that this comment links to the section and not the whole page of the backend processor.
There was a problem hiding this comment.
@giortzisg, I explained it here as well because it felt a bit odd to me to define the common requirements here without stating that for some approaches, they don't apply. It felt a bit odd to define it here and then, in the backend page, saying, "Hey, and by the way, these requirements in the index page don't apply here."
Just to clarify, you also want to explain a complete pull-based approach here, which would mean that we should extract the pull-based approach with all the round robin stuff from the backend? Or what exactly would you put into this section here on the index page?
| #### TelemetryBuffer | ||
|
|
||
| The telemetry buffer on the backend must follow the common [telemetry buffer requirements](/sdk/foundations/processing/telemetry-processor/#telemetry-buffer). Here are the additional requirements for the backend-specific implementation: | ||
| Unlike the [push-based approach](/sdk/foundations/processing/telemetry-processor/#push-based-approach), the telemetry buffer does not push data to the telemetry scheduler. Instead, the [telemetry scheduler](#telemetryscheduler) iterates through all buffers using weighted round-robin and pulls data when it determines a buffer is ready to flush. Still, the telemetry buffer **MUST** follow the common [telemetry buffer requirements](/sdk/foundations/processing/telemetry-processor/#telemetry-buffer). Here are the additional backend-specific requirements: |
There was a problem hiding this comment.
| Unlike the [push-based approach](/sdk/foundations/processing/telemetry-processor/#push-based-approach), the telemetry buffer does not push data to the telemetry scheduler. Instead, the [telemetry scheduler](#telemetryscheduler) iterates through all buffers using weighted round-robin and pulls data when it determines a buffer is ready to flush. Still, the telemetry buffer **MUST** follow the common [telemetry buffer requirements](/sdk/foundations/processing/telemetry-processor/#telemetry-buffer). Here are the additional backend-specific requirements: | |
| Unlike the [push-based approach](/sdk/foundations/processing/telemetry-processor/#push-based-approach), the telemetry buffer does not push data to the telemetry scheduler. Instead, the [telemetry scheduler](#telemetryscheduler) iterates through all buffers using weighted round-robin scheduling and pulls data when it determines a buffer is ready to flush. Still, the telemetry buffer **MUST** follow the common [telemetry buffer requirements](/sdk/foundations/processing/telemetry-processor/#telemetry-buffer). Here are the additional backend-specific requirements: |
…ckend-telemetry-processor.mdx Co-authored-by: Giannis Gkiortzis <58184179+giortzisg@users.noreply.github.com>
DESCRIBE YOUR PR
Based on #16652. Part of #16189.
Clarifies the difference between the push-based and pull-based telemetry buffer approaches and adds cross-links between them.
Co-Authored-By: Claude noreply@anthropic.com
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: