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.