Repository files navigation

This is theGo client library forPrometheus. It has two separate parts, one forinstrumenting application code, and one for creating clients that talk to thePrometheus HTTP API.

This library supports the two most recent major releases of Go. While it may function with older versions, we only provide fixes and support for the currently supported Go releases.

This repository generally followsSemanticVersioning. However, the API client inprometheus/client_golang/api/… is still considered experimental. Breakingchanges of the API client willnot trigger a new major release. The same istrue for selected other new features explicitly marked asEXPERIMENTAL inCHANGELOG.md.

Features that require breaking changes in the stable parts of the repositoryare being batched up and tracked in thev2milestone, but plans for further development of v2 at the moment.

NOTE: The initial v2 attempt is in aseparate branch. We also startedexperimenting on a newprometheus.V2.* APIs inthe 1.x's V2 struct. Help wanted!

Theprometheus directorycontains the instrumentation library. See theguide on the Prometheuswebsite to learn more about instrumenting applications.

Theexamples directorycontains simple examples of instrumented code.

Theapi/prometheus directorycontains the client for thePrometheus HTTP API. It allows youto write Go applications that query time series data from a Prometheusserver. It is still in alpha stage.

Themodel packages has been moved toprometheus/common/model.

Theextraction andtext packages are now contained inprometheus/common/expfmt.

See thecontributing guidelines and theCommunity section of the homepage.

client_golang community is also present on the CNCF Slack#prometheus-client_golang.