API 稳定性保证

Prometheus 承诺在主版本内保持 API 稳定性,并努力避免对关键功能进行重大更改。某些功能(例如外观、仍在开发中或依赖第三方服务的功能)不在此范围内。

3.x 版本中被认为是稳定的内容

  • 查询语言和数据模型
  • 告警和记录规则
  • 摄取暴露格式
  • v1 HTTP API(由仪表板和 UI 使用)
  • 配置文件格式(减去服务发现远程读取/写入,见下文)
  • 规则/告警文件格式
  • 控制台模板语法和语义
  • 按照 1.0 规范 发送和接收远程写入
  • 代理模式
  • OTLP 接收器端点

3.x 版本中被认为是不稳定的内容

  • 任何被列为实验性或可能会更改的功能,包括
  • 服务器端 HTTPS 和基本身份验证
  • 服务发现集成,但 static_configsfile_sd_configshttp_sd_config 除外
  • 服务器组成部分的 Go API
  • Web UI 生成的 HTML
  • Prometheus 自身的 /metrics 端点中的指标
  • 确切的磁盘格式。但是,潜在的更改将是向前兼容的,并且由 Prometheus 透明地处理
  • 日志的格式

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

只要您不使用任何标记为实验性/不稳定的功能,通常可以在主版本内执行升级,而无需进行任何操作调整,并且几乎没有发生任何故障的风险。任何重大更改都将在发行说明中标记为 CHANGE

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