API安定性保証

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

2.xで安定していると見なされるもの

  • クエリ言語とデータモデル
  • アラートとレコーディングルール
  • 取り込みエクスポジションフォーマット
  • v1 HTTP API(ダッシュボードとUIで使用)
  • 設定ファイル形式(以下のサービスディスカバリのリモート読み取り/書き込みを除く)
  • ルール/アラートファイル形式
  • コンソールテンプレートの構文とセマンティクス
  • 1.0仕様に準拠したリモート書き込み送信。

2.xで不安定であると見なされるもの

  • 実験的または変更の可能性があると記載されている機能、以下を含む
    • holt_winters PromQL関数
    • リモート書き込み受信、リモート読み取り、およびリモート読み取りエンドポイント
  • サーバー側のHTTPSとベーシック認証
  • static_configsfile_sd_configsを除くサービスディスカバリ統合
  • サーバーの一部であるパッケージのGo API
  • Web UIによって生成されたHTML
  • Prometheus自体の/metricsエンドポイントのメトリック
  • 正確なディスク上のフォーマット。ただし、潜在的な変更は前方互換性があり、Prometheusによって透過的に処理されます
  • ログのフォーマット

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

このドキュメントはオープンソースです。問題の報告またはプルリクエストを送信して、改善にご協力ください。