API 稳定性保证

Prometheus 在主版本内保证 API 稳定性,并努力避免对关键功能进行破坏性更改。某些功能,如美化、仍在开发中或依赖第三方服务的功能,不在此保证范围内。

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

  • 查询语言和数据模型
  • 告警和录制规则
  • 摄入暴露格式
  • v1 HTTP API(由仪表板和 UI 使用),不包括明确标记为实验性的端点
  • 配置文件格式(不包括服务发现的 remote read/write,见下文)
  • 规则/告警文件格式
  • 控制台模板语法和语义
  • 远程写入发送,根据 1.0 规范 和接收
  • Agent 模式
  • OTLP 接收器端点

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

  • 任何被标记为实验性或可能更改的功能,包括
    • double_exponential_smoothing PromQL 函数
    • 远程读取和远程读取端点
  • 服务器端 HTTPS 和基本身份验证
  • 服务发现集成,不包括 static_configsfile_sd_configshttp_sd_config
  • 作为服务器一部分的包的 Go API
  • Web UI 生成的 HTML
  • Prometheus 本身 /metrics 端点中的指标
  • 确切的磁盘格式。但潜在的更改将是向前兼容的,并由 Prometheus 透明处理
  • 日志格式

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

只要您不使用任何被标记为实验性/不稳定的功能,通常可以在不进行任何操作调整且风险极小的情况下,在主版本内进行升级。任何破坏性更改将在发布说明中标记为 CHANGE

本页内容