APIの安定性保証 - Prometheusドキュメント

このページはPrometheus公式ドキュメント和訳+αの一部です。

APIの安定性保証

Prometheusは、1つのメジャーバージョン内でのAPIの安定性を約束しており、鍵となる機能の破壊的な変更を避けるように努力する。 ただし、見栄えに関する機能、まだ開発中の機能、サードパーティのサービスに依存する機能には、これが当てはまらないものもある。

2.xで安定と考えられているものは以下の通り。

  • クエリ言語とデータモデル
  • アラーティングルールとレコーディングルール
  • メトリクスの出力フォーマット
  • v1 HTTP APIダッシュボードとUIで利用される)
  • 設定ファイルのフォーマット(サービスディスカバリーとremote read/writeは除く。下記参照)
  • ルール/アラートのファイルフォーマット
  • コンソールテンプレートの構文と意味

2.xで不安定と考えられているものは以下の通り。

  • 以下を含む、実験的または変更を受けるとされている機能
    • PromQL関数holt_winters
    • remote read、remote writeおよびremote readエンドポイント
    • v2 HTTPとGRPC APIs
  • サービスディスカバリー連携(static_configsfile_sd_configsを除く)
  • サーバーの一部であるパッケージのGo API
  • Web UIで生成されるHTML
  • エンドポイント/metricsで出力されるPrometheus自体のメトリクス
  • ディスク上のフォーマット。ただし、もし変更があっても前方互換でPrometheusは透過的に扱うだろう

実験的(experimental)/不安定(unstable)と記された機能を使わない限り、あるメジャーバージョン内でのアップグレードは 普通は調整なしで行うことが出来て、何かが壊れるリスクはとても少ない。 破壊的な変更は、リリースノートでCHANGEと記される。

参考リンク

おすすめ書籍

入門 Prometheus ―インフラとアプリケーションのパフォーマンスモニタリング

入門 Prometheus ―インフラとアプリケーションのパフォーマンスモニタリング

 
入門 監視 ―モダンなモニタリングのためのデザインパターン

入門 監視 ―モダンなモニタリングのためのデザインパターン

 
SRE サイトリライアビリティエンジニアリング ―Googleの信頼性を支えるエンジニアリングチーム

SRE サイトリライアビリティエンジニアリング ―Googleの信頼性を支えるエンジニアリングチーム