mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-11-15 18:14:06 -08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
prometheus/docs/stability.md
Bryan Boreham b1b8fd77c4 docs: state that remote write is stable 
Since https://github.com/prometheus/docs/pull/2313 has been merged
declaring remote write to be stable at version 1.0.

Signed-off-by: Bryan Boreham <bjboreham@gmail.com>
2023-05-09 10:29:52 +00:00

1.7 KiB
Raw Blame History

title sort_rank
API Stability 11

API Stability Guarantees

Prometheus promises API stability within a major version, and strives to avoid breaking changes for key features. Some features, which are cosmetic, still under development, or depend on 3rd party services, are not covered by this.

Things considered stable for 2.x:

  • The query language and data model
  • Alerting and recording rules
  • The ingestion exposition format
  • v1 HTTP API (used by dashboards and UIs)
  • Configuration file format (minus the service discovery remote read/write, see below)
  • Rule/alert file format
  • Console template syntax and semantics
  • Remote write sending, per the 1.0 specification.

Things considered unstable for 2.x:

  • Any feature listed as experimental or subject to change, including:
  • Server-side HTTPS and basic authentication
  • Service discovery integrations, with the exception of static_configs and file_sd_configs
  • Go APIs of packages that are part of the server
  • HTML generated by the web UI
  • The metrics in the /metrics endpoint of Prometheus itself
  • Exact on-disk format. Potential changes however, will be forward compatible and transparently handled by Prometheus
  • The format of the logs

As long as you are not using any features marked as experimental/unstable, an upgrade within a major version can usually be performed without any operational adjustments and very little risk that anything will break. Any breaking changes will be marked as CHANGE in release notes.