grafana/pyroscope

[DOC] Update doc to reflect thread sampling logic required for tracing integration on

Open

#3,482 创建于 2024年8月13日

在 GitHub 查看
 (1 评论) (1 反应) (0 负责人)C (9,041 star) (528 fork)batch import
dotnetgood first issuetype/docs

描述

Update the docs to include this:

Walltime profiling is required to have thread sampling logic changed with the tracing integration on. However, this information is not included in the docs.

In the docs, walltime profiling is only mentioned in the .NET SDK: https://grafana.com/docs/pyroscope/latest/configure-client/language-sdks/dotnet/#dynamic-control

The trace to profiles documentation is on this page: https://grafana.com/docs/pyroscope/latest/configure-client/trace-span-profiles/dotnet-span-profiles/

Tasks:

  • Verify the information is correct
  • Which config options are useful for this?
  • Provide an example in the config option for the tracing integration

贡献者指南

技术栈
ccpp
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Pyroscope profiling basicsWalltime profiling conceptTracing integration knowledge
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Review the linked C++ file (StackSamplerLoop.cpp) to understand the thread sampling logic. Check the existing documentation pages at https://grafana.com/docs/pyroscope/latest/configure client/language sdks/dotnet/#dynamic control and https://grafana.com/docs/pyroscope/latest/configure client/trace span profiles/dotnet span profiles/. Verify the information is correct and identify which configuration options are relevant for tracing integration. Provide an example configuration snippet for the tracing integration docs.
[DOC] Update doc to reflect thread sampling logic required for tracing integration on · grafana/pyroscope#3482 | Good First Issue