Skip to content

Clarify exp library stability #1894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 17, 2025
Merged

Clarify exp library stability #1894

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ca982f
change readme
pipiland2612 Oct 17, 2025
ec80250
Apply suggestion from @bwplotka
pipiland2612 Oct 17, 2025
e512db4
Remove unecessary description
pipiland2612 Oct 17, 2025
37a9c2d
Merge branch 'main' into clarify-exp-stability
pipiland2612 Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions exp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# client_golang experimental module

Contains experimental utilities and APIs for Prometheus.
The module may be contain breaking changes or be removed in the future.

Packages within this module are listed below.

## Remote

This module contains production quality code with explicitly unstable API. Any code in this module can change its API or be removed; use with care.

The intention is that, with maturity some of the packages would graduate to stable version of client_golang module.

Packages within this module are listed below.

## Remote

NOTE: The `api/remote` package is used by `prometheus/prometheus`. Any changes to this package should ensure Prometheus is not affected (e.g. does not break Prometheus on upgrade or if it breaks, the Prometheus gets updated soon.
Implements bindings from Prometheus remote APIs (remote write v1 and v2 for now).

Contains flexible method for building API clients, that can send remote write protocol messages.
Expand Down Expand Up @@ -59,4 +67,4 @@ Also contains handler methods for applications that would like to handle and sto
}
```

For more details, see [go doc](https://pkg.go.dev/github.com/prometheus/client_golang/exp/api/remote).
For more details, see [go doc](https://pkg.go.dev/github.com/prometheus/client_golang/exp/api/remote).
Loading