grafana/pyroscope

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

Open

Aperta il 13 ago 2024

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)C (9041 star) (528 fork)batch import
dotnetgood first issuetype/docs

Descrizione

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

Guida contributor

Tech stack
ccpp
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Pyroscope profiling basicsWalltime profiling conceptTracing integration knowledge
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70
Direzione di ricerca
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.