jaegertracing/jaeger

[v2] Auto-generate configuration documentation

Open

Aperta il 9 nov 2024

Vedi su GitHub
 (11 commenti) (0 reazioni) (0 assegnatari)Go (18.974 star) (2326 fork)batch import
area/otelgood first issuehelp wantedv2

Descrizione

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)

Guida contributor

Tech stack
go
Dominio
documentation
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Go programmingBasic understanding of configuration schemasFamiliarity with OTEL collector
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60
Direzione di ricerca
Per prima cosa, prova a eseguire lo script schemagen dal repository OTEL collector contrib (vedi https://github.com/open telemetry/opentelemetry collector contrib/blob/main/cmd/schemagen/README.md) su una delle estensioni interne del collector di Jaeger per vedere se produce schemi sensati. Quindi, in base all'output, implementa la generazione automatica della documentazione di configurazione seguendo l'approccio utilizzato nel progetto OTEL, possibilmente facendo riferimento al generatore di documentazione configschema. Consulta le PR e gli issue collegati per i modelli.