API の安定性保証

Prometheus は、メジャーバージョン内での API の安定性を保証し、主要な機能については破壊的な変更を避けるよう努めています。ただし、装飾的なもの、開発中のもの、またはサードパーティのサービスに依存する一部の機能は、これに含まれません。

3.x で安定していると考えられるもの

  • クエリ言語とデータモデル
  • アラートおよび記録ルール
  • 取り込み公開フォーマット
  • v1 HTTP API (ダッシュボードや UI で使用、明示的に実験的とマークされたエンドポイントを除く)
  • 設定ファイルフォーマット (サービス検出のリモート読み取り/書き込みを除く、以下参照)
  • ルール/アラートファイルフォーマット
  • コンソールテンプレートの構文とセマンティクス
  • リモート書き込みの送信(1.0 仕様に従う)と受信
  • エージェントモード
  • OTLP 受信エンドポイント

3.x で不安定と考えられるもの

  • 以下を含む、実験的または変更の対象となる可能性のある機能
  • サーバーサイド HTTPS および Basic 認証
  • サービス検出の統合 (static_configsfile_sd_configshttp_sd_config を除く)
  • サーバーの一部であるパッケージの Go API
  • Web UI によって生成される HTML
  • Prometheus 自体の /metrics エンドポイントのメトリック
  • ディスク上の正確なフォーマット。ただし、将来の変更は下位互換性があり、Prometheus によって透過的に処理されます。
  • ログのフォーマット

Prometheus 2.x の安定性保証については、2.x のドキュメントを参照してください。

実験的/不安定とマークされた機能を使用しない限り、メジャーバージョン内のアップグレードは、運用上の調整をほとんど行わず、破損のリスクも非常に少なく実行できます。破壊的な変更は、リリースノートで CHANGE としてマークされます。

このページの内容