From 1d5486caaa39cc42f017e14d8b353ed8883eb595 Mon Sep 17 00:00:00 2001 From: Bryan Boreham Date: Tue, 3 Feb 2026 08:52:11 +0000 Subject: [PATCH] Explain more about using Prometheus as a Go library Signed-off-by: Bryan Boreham --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 7b04a51cee..030a827952 100644 --- a/README.md +++ b/README.md @@ -159,6 +159,15 @@ produce a fully working image when run locally. ## Using Prometheus as a Go Library +Within the Prometheus project, repositories such as [prometheus/common](https://github.com/prometheus/common) and +[prometheus/client-golang](https://github.com/prometheus/client-golang) are designed as re-usable libraries. + +The [prometheus/prometheus](https://github.com/prometheus/prometheus) repository builds a stand-alone program and is not +designed for use as a library. We are aware that people do use parts as such, +and we do not put any deliberate inconvenience in the way, but we want you to be +aware that no care has been taken to make it work well as a library. For instance, +you may encounter errors that only surface when used as a library. + ### Remote Write We are publishing our Remote Write protobuf independently at