Skip to content

Commit 9358c16

Browse files
Clarify exp library stability (#1894)
* change readme Signed-off-by: pipiland2612 <nguyen.t.dang.minh@gmail.com> * Apply suggestion from @bwplotka Co-authored-by: Bartlomiej Plotka <bwplotka@gmail.com> Signed-off-by: Minh Nguyen <148210689+pipiland2612@users.noreply.github.com> * Remove unecessary description Removed cautionary note about reliance on the code. Signed-off-by: Minh Nguyen <148210689+pipiland2612@users.noreply.github.com> --------- Signed-off-by: pipiland2612 <nguyen.t.dang.minh@gmail.com> Signed-off-by: Minh Nguyen <148210689+pipiland2612@users.noreply.github.com> Co-authored-by: Bartlomiej Plotka <bwplotka@gmail.com>
1 parent ddad4f3 commit 9358c16

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

exp/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
# client_golang experimental module
22

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

65
Packages within this module are listed below.
76

87
## Remote
98

9+
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.
10+
11+
The intention is that, with maturity some of the packages would graduate to stable version of client_golang module.
12+
13+
Packages within this module are listed below.
14+
15+
## Remote
16+
17+
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.
1018
Implements bindings from Prometheus remote APIs (remote write v1 and v2 for now).
1119

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

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

0 commit comments

Comments
 (0)