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

本页内容