grafana/pyroscope

Provide better example configuration in repo

Open

#3.835 aberto em 13 de jan. de 2025

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)C (9.041 stars) (528 forks)batch import
good first issuehelp wantedtype/docs

Description

I think we should provide a better example config file in ./cmd/pyroscope/pyroscope.yaml.

The configuration page in our docs seem to be tricky to understand, as they use a "reference name" for certain sections, which often is confused by users. (example 1, example 2)

All the options should be commented out, ideally generated from the existing structs.

Guia do colaborador

Pilha de tecnologia
go
Domain
documentationbackend
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Go knowledgefamiliarity with YAML config
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
Look at the existing example config in ./cmd/pyroscope/pyroscope.yaml and the struct definitions in Go source code that generate the configuration reference. Determine how to auto generate commented out options from the structs, ensuring all options are present with clear comments. Check related issues (e.g., #3790) and Slack discussion for user confusion. Review maintainer comments in this issue for expected output format.