grafana/pyroscope

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

Open

#3.482 aberto em 13 de ago. de 2024

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)C (528 forks)batch import
dotnetgood first issuetype/docs

Métricas do repositório

Stars
 (9.041 stars)
Métricas de merge de PR
 (Mesclagem média 5d 7h) (62 fundiu PRs em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
Revise o código StackSamplerLoop.cpp e a documentação atual nos URLs fornecidos. Confirme o requisito de perfilamento walltime, identifique opções de configuração relevantes e atualize a página de documentação trace to profiles com uma explicação clara e um exemplo.
Pilha de tecnologia
csharp
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85