grafana/pyroscope

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

Open

#3 482 ouverte le 13 août 2024

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)C (528 forks)batch import
dotnetgood first issuetype/docs

Métriques du dépôt

Stars
 (9 041 stars)
Métriques de merge PR
 (Merge moyen 5j 7h) (62 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez le code StackSamplerLoop.cpp et la documentation actuelle aux URL fournies. Confirmez l'exigence de profilage walltime, identifiez les options de configuration pertinentes et mettez à jour la page de documentation trace to profiles avec une explication claire et un exemple.
Stack technique
csharp
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85