grafana/pyroscope

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

Open

#3482 aperta il 13 ago 2024

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

Metriche repository

Star
 (9041 star)
Metriche merge PR
 (Merge medio 5g 7h) (62 PR mergiate in 30 g)

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

Direzione di ricerca
Esamina il codice StackSamplerLoop.cpp e la documentazione corrente agli URL forniti. Conferma il requisito del profiling walltime, identifica le opzioni di configurazione pertinenti e aggiorna la pagina della documentazione trace to profiles con una spiegazione chiara e un esempio.
Tech stack
csharp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85