jaegertracing/jaeger

[v2] Auto-generate configuration documentation

Open

#6,186 opened on 2024年11月9日

GitHub で見る
 (11 comments) (0 reactions) (0 assignees)Go (18,974 stars) (2,326 forks)batch import
area/otelgood first issuehelp wantedv2

説明

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)

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

技術スタック
go
領域
documentation
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
active
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Go programmingBasic understanding of configuration schemasFamiliarity with OTEL collector
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
First, try running the schemagen script from the OTEL collector contrib repository (see https://github.com/open telemetry/opentelemetry collector contrib/blob/main/cmd/schemagen/README.md) on one of Jaeger's internal collector extensions to see if it produces sensible schemas. Then, based on the output, implement auto generation of configuration documentation following the approach used in the OTEL project, possibly referencing the configschema docs generator. Consult the linked PRs and issues for patterns.