jaegertracing/jaeger

[v2] Auto-generate configuration documentation

オープン

#6,186 opened on 2024/11/09

 (11 件のコメント) (0 件のリアクション) (0 人の担当者)Go (2,326 件のフォーク)batch import
area/otelgood first issuehelp wantedv2

Repository metrics

Stars
 (18,974 個のスター)
PR merge metrics
 (平均マージ 4d 11h) (30d で 85 merged PRs)

説明

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)

コントリビューターガイド