prometheus / prometheus/prometheus

Mark remote read protocol and serving impl as stable.

Open
#14,158 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component/remote storage
Dominant language
Go
Stars
66.1k
Forks
10.8k
Avg merge
2d 1h
Merged PRs (30d)
131

Description

Proposal

Our docs mentions remote read as not currently considered part of the stable API and is subject to change even between non-major version releases of Prometheus.. In practice this is not true, we never broke it, even when adding streaming mode. We are particularly careful when attempting any features.

I propose we mark the protocol and serving implementation stable. The motivation comes from DMs asking me if this protocol is really unstable and if they can use it in production. Obviously it's production ready, but some companies require this on paper. Perhaps do it on 3.x?

I am not sure about client implementation, I am personally not interested in maintaining/improving that use case--there are better tools to do aggregate from multiple sources than Prometheus (e.g. Thanos Querier, promxy), but maybe there are different opinions here. It feels we could achieve more deprecating this case for Prometheus (e.g. this blocked some PromQL engine optimizations in the past).

Acceptance Criteria

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the stability page and the remote read API documentation linked in the issue, then review the open discussion about the protocol, serving implementation, and client scope. Done means consensus on the stability change and updated wording on both documentation pages.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.