API 稳定性保证

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

3.x 版本中被认为是稳定的功能

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

3.x 版本中被认为是不稳定的功能

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

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

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

本文档是开源的。请通过提交 issue 或 pull request 来帮助改进它。