API 稳定性保证

Prometheus 承诺在一个主版本内保持 API 稳定性，并努力避免关键功能的重大变更。一些功能，例如界面相关的、仍在开发中的或依赖于第三方服务的，不在此承诺范围内。

3.x 版本被认为稳定的特性

  • 查询语言与数据模型
  • 告警规则与记录规则
  • 摄取暴露格式
  • v1 HTTP API（由仪表盘和 UI 使用）
  • 配置文件格式（不包括服务发现的远程读取/写入，见下文）
  • 规则/告警文件格式
  • 控制台模板语法与语义
  • 按照1.0 规范进行的远程写入发送与接收
  • Agent 模式
  • OTLP 接收端点

3.x 版本被认为不稳定的特性

  • 任何列为实验性或可能更改的特性，包括
  • 服务器端 HTTPS 与基本认证
  • 服务发现集成，但排除 static_configs, file_sd_configs 和 http_sd_config
  • 作为服务器一部分的 Go 包的 API
  • Web UI 生成的 HTML
  • Prometheus 自身 /metrics 端点中的指标
  • 确切的磁盘格式。然而，潜在的变更将向前兼容并由 Prometheus 透明地处理
  • 日志格式

Prometheus 2.x 的稳定性保证可以在2.x 文档中找到。

只要您不使用任何标记为实验性/不稳定的特性，在主版本内升级通常无需进行任何操作调整，且几乎不会出现任何问题。任何重大变更将在发布说明中标记为 CHANGE。

本文档是开源的。请通过提交问题或拉取请求来帮助改进它。