mirror of
https://github.com/prometheus/prometheus.git
synced 2024-12-26 06:04:05 -08:00
f131cdd4c5
Some checks are pending
buf.build / lint and publish (push) Waiting to run
CI / Go tests (push) Waiting to run
CI / More Go tests (push) Waiting to run
CI / Go tests with previous Go version (push) Waiting to run
CI / UI tests (push) Waiting to run
CI / Go tests on Windows (push) Waiting to run
CI / Mixins tests (push) Waiting to run
CI / Build Prometheus for common architectures (0) (push) Waiting to run
CI / Build Prometheus for common architectures (1) (push) Waiting to run
CI / Build Prometheus for common architectures (2) (push) Waiting to run
CI / Build Prometheus for all architectures (0) (push) Waiting to run
CI / Build Prometheus for all architectures (1) (push) Waiting to run
CI / Build Prometheus for all architectures (10) (push) Waiting to run
CI / Build Prometheus for all architectures (11) (push) Waiting to run
CI / Build Prometheus for all architectures (2) (push) Waiting to run
CI / Build Prometheus for all architectures (3) (push) Waiting to run
CI / Build Prometheus for all architectures (4) (push) Waiting to run
CI / Build Prometheus for all architectures (5) (push) Waiting to run
CI / Build Prometheus for all architectures (6) (push) Waiting to run
CI / Build Prometheus for all architectures (7) (push) Waiting to run
CI / Build Prometheus for all architectures (8) (push) Waiting to run
CI / Build Prometheus for all architectures (9) (push) Waiting to run
CI / Report status of build Prometheus for all architectures (push) Blocked by required conditions
CI / Check generated parser (push) Waiting to run
CI / golangci-lint (push) Waiting to run
CI / fuzzing (push) Waiting to run
CI / codeql (push) Waiting to run
CI / Publish main branch artifacts (push) Blocked by required conditions
CI / Publish release artefacts (push) Blocked by required conditions
CI / Publish UI on npm Registry (push) Blocked by required conditions
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
* docs: 2 to 3 migration guide Signed-off-by: Jan Fajerski <jfajersk@redhat.com> * docs/stability: add 3.0 section Signed-off-by: Jan Fajerski <jfajersk@redhat.com> * docs/migration: details on enabling legacy name validation Signed-off-by: Owen Williams <owen.williams@grafana.com>\ * migration: add log format and `le` normalization Signed-off-by: Jan Fajerski <jfajersk@redhat.com> * migration: add new enable_http2 default for remote write Signed-off-by: Jan Fajerski <jfajersk@redhat.com> --------- Signed-off-by: Jan Fajerski <jfajersk@redhat.com> Signed-off-by: Owen Williams <owen.williams@grafana.com> Co-authored-by: Owen Williams <owen.williams@grafana.com>
45 lines
1.9 KiB
Markdown
45 lines
1.9 KiB
Markdown
---
|
|
title: API Stability
|
|
sort_rank: 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 3.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](https://prometheus.io/docs/concepts/remote_write_spec/) and receiving
|
|
* Agent mode
|
|
* OTLP receiver endpoint
|
|
|
|
Things considered unstable for 3.x:
|
|
|
|
* Any feature listed as experimental or subject to change, including:
|
|
* The [`double_exponential_smoothing` PromQL function](https://github.com/prometheus/prometheus/issues/2458)
|
|
* Remote read and the remote read endpoint
|
|
* Server-side HTTPS and basic authentication
|
|
* Service discovery integrations, with the exception of `static_configs`, `file_sd_configs` and `http_sd_config`
|
|
* 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
|
|
|
|
Prometheus 2.x stability guarantees can be found [in the 2.x documentation](https://prometheus.io/docs/prometheus/2.55/stability/).
|
|
|
|
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.
|
|
|