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

本页内容