grafana/pyroscope

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

Open

#3,482 opened on 2024年8月13日

GitHub で見る
 (1 comment) (1 reaction) (0 assignees)C (9,041 stars) (528 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.