jaegertracing/jaeger

[v2] Auto-generate configuration documentation

Open

#6.186 aberto em 9 de nov. de 2024

Ver no GitHub
 (11 comments) (0 reactions) (0 assignees)Go (2.326 forks)batch import
area/otelgood first issuehelp wantedv2

Métricas do repositório

Stars
 (18.974 stars)
Métricas de merge de PR
 (Mesclagem média 4d 15h) (89 fundiu PRs em 30d)

Description

We want to employ a schema-first approach to configuration:

  • define a schema for configuration structures first
  • use code generator to create types in Go
  • automatically generate documentation from the schema

(30-Jan-2026) The OTEL Collector is also moving in this direction, with the first phase available where Go structs can be parsed to generate schema in YAML (https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/45732)

References:

Tasks:

  • Try running the schemagen script on some of Jaeger's internal collector extensions to see if it can generate sensible schemas.
  • Auto-generate documentation from those schemas (follow OTEL example)

Guia do colaborador

Direção de pesquisa
Primeiro, tente executar o script schemagen do repositório OTEL collector contrib (veja https://github.com/open telemetry/opentelemetry collector contrib/blob/main/cmd/schemagen/README.md) em uma das extensões internas do coletor do Jaeger para ver se ele produz schemas sensatos. Em seguida, com base na saída, implemente a geração automática de documentação de configuração seguindo a abordagem usada no projeto OTEL, possivelmente referenciando o gerador de documentação configschema. Consulte os PRs e issues vinculados para obter padrões.
Pilha de tecnologia
go
Domain
documentation
Tipo Issue
Funcionalidade
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-2 dias
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
Go programmingBasic understanding of configuration schemasFamiliarity with OTEL collector
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60