API 穩定性保證

Prometheus 承諾在主版本內保持 API 穩定性,並努力避免對關鍵功能進行破壞性更改。一些僅涉及外觀、仍在開發中或依賴第三方服務的特性不在此保障範圍內。

在 3.x 中被視為穩定的內容

  • 查詢語言和資料模型
  • 告警和記錄規則
  • 攝取暴露格式
  • v1 HTTP API(供儀表盤和 UI 使用),不包括明確標記為實驗性的端點
  • 配置檔案格式(不包括服務發現及遠端讀/寫,見下文)
  • 規則/告警檔案格式
  • 控制檯模板語法和語義
  • 遠端寫入傳送(根據 1.0 規範)和接收
  • Agent 模式
  • OTLP 接收器端點

在 3.x 中被視為不穩定的內容

  • 任何被列為實驗性或可能發生變化的特性,包括
  • 服務端 HTTPS 和基本身份驗證
  • 服務發現整合,但 static_configsfile_sd_configshttp_sd_config 除外
  • 屬於伺服器一部分的包的 Go API
  • Web UI 生成的 HTML
  • Prometheus 自身 /metrics 端點中的指標
  • 確切的磁碟格式。不過,任何潛在的更改都將向前相容並由 Prometheus 透明處理
  • 日誌格式

Prometheus 2.x 穩定性保證可以在 2.x 文件中找到。

只要您不使用任何標記為實驗性/不穩定的功能,通常可以在不進行任何運維調整的情況下進行主版本內的升級,且極少有損壞風險。任何破壞性變更都將在釋出說明中標記為 CHANGE

本頁內容