Yoshi Yamaguchi

ドキュメントステータスの定義

この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/otel/document-status/

翻訳元: open-telemetry/opentelemetry-specification v1.60.0（コミット 29ae8c7）

仕様書のドキュメント（ファイル）は、通常ドキュメントのタイトル直後に示される「ステータス」を明示的に定義することがあります。「ステータス」が存在する場合、それは個々のドキュメントのみに適用され、仕様書全体や他のドキュメントには適用されません。以下の表は各ステータスの意味を説明します。

成熟度レベル

サポートの保証と許容される変更は、ドキュメントの成熟度レベルによって規定されます。成熟度レベルはOTEP 0232で定義されており、コンポーネントの成熟度を記述するOpenTelemetryプロジェクトの標準的な枠組みに従います。

ステータス説明
明示的な「ステータス」なしAlphaと同等。
Developmentコンポーネントのすべての部分がまだ揃っておらず、ユーザーが利用できない場合があります。バグやパフォーマンスの問題が報告されることが見込まれます。設定オプション、コンポーネントのオブザーバビリティ、技術的な実装の詳細、想定される使用ケースなど、コンポーネントのUXに関するユーザーフィードバックが望まれます。設定オプションは、物事の進展によって頻繁に変わる可能性があります。コンポーネントは本番環境で使用すべきではありません（SHOULD NOT）。コンポーネントは事前の通知なしに削除されることがあります（MAY）。
Alphaコンポーネントは、重要度の低い本番ワークロードに限定して使用できる状態であり、この作者はユーザーからのフィードバックを歓迎します。バグやパフォーマンスの問題の報告は推奨されますが、コンポーネントの所有者がすぐには対応しない場合があります。コンポーネントのインターフェースと設定オプションは、後方互換性の保証なしに頻繁に変更されることがあります。この段階のコンポーネントは、通知なくいつでも取り下げられることがあります。
BetaAlphaと同様ですが、インターフェース（API、設定、生成されるテレメトリー）は可能な限り安定しているものとして扱われます。リリース間で破壊的変更が生じることはありますが、コンポーネントの所有者はそれを最小限に抑えるよう努めるべきです。この段階のコンポーネントは、Alphaの段階で重要度の低い本番ワークロードへの露出を既に経験していることが期待され、より広い用途に適しています。
Release Candidateコンポーネントは機能的に完成しており、より広範な利用に対応できます。コンポーネントは安定版として宣言される準備ができていますが、それが実現する前に、より多くの本番環境でテストされる必要があるかもしれません。バグやパフォーマンスの問題が報告されることが見込まれ、コンポーネントの所有者がそれに対応することが期待されます。設定オプションやコンポーネントの出力を含む破壊的変更は、特別な事情がある場合にのみ許容されます。可能な限り、ユーザーには破壊的変更について事前に通知すべきです。
Stableコンポーネントは一般提供の準備ができています。バグやパフォーマンスの問題は報告されるべきであり、コンポーネントの所有者がそれに対応することが期待されます。設定オプションやコンポーネントの出力を含む破壊的変更は、特別な事情がある場合にのみ許容されます。可能な限り、ユーザーには破壊的変更について事前に通知すべきです。詳細は安定性の保証を参照してください。
Deprecatedこのコンポーネントの開発は停止しています。新しいバージョンの計画はなく、コンポーネントは組み込まれているディストリビューションから削除される場合があります。重大なセキュリティ問題を除き、新しいissueへの対応はおそらく行われないことに注意してください。ディストリビューションに含まれるコンポーネントは、少なくとも2回のマイナーリリースまたは6か月のいずれか長いほうの期間は存続することが見込まれます。また、どのバージョンで削除されるかをMUST伝えるものとします。
UnmaintainedUnmaintainedと識別されたコンポーネントには、活動中のコードオーナーがいません。このようなコンポーネントは、コードオーナーが割り当てられたことがない場合もあれば、以前活動していたコードオーナーが連絡を受けてから6週間以内にフィードバックの依頼へ応答しなかった場合もあります。Unmaintainedなコンポーネントに対するissueとプルリクエストは、そのようにラベル付けされるべきです（SHOULD）。Unmaintainedの状態が6か月続くと、これらのコンポーネントはDeprecatedになることがあります（MAY）。Unmaintainedなコンポーネントは、コードオーナーになってくれるコントリビューターを積極的に募集しています。

仕様書はOTEP 0232の成熟度レベルの定義に従います。

Mixed

一部のドキュメントには、個々のセクションに異なるステータスが設定されています。こうしたドキュメントは、明確にするためトップにMixedというステータスが記載されます。