GitHub - prometheus/client_golang at dev-v2 (original) (raw)

Prometheus Go client library

This is the Go client library forPrometheus. It has two separate parts, one for instrumenting application code, and one for creating clients that talk to the Prometheus HTTP API.

This library requires Go1.9 or later.

Important note about releases and stability

This repository generally follows Semantic Versioning. However, the API client in prometheus/client_golang/api/… is still considered experimental. Breaking changes of the API client will not trigger a new major release. The same is true for selected other new features explicitly marked as EXPERIMENTAL in CHANGELOG.md.

Features that require breaking changes in the stable parts of the repository are being batched up and tracked in the v2 milestone. The v2 development happens in a separate branch for the time being. v2 releases off that branch will happen once sufficient stability is reached. In view of the widespread use of this repository, v1 and v2 will coexist for a while to enable a convenient transition.

Instrumenting applications

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

Theexamples directorycontains simple examples of instrumented code.

Client for the Prometheus HTTP API

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

Where is model, extraction, and text?

The model packages has been moved toprometheus/common/model.

The extraction and text packages are now contained inprometheus/common/expfmt.

Contributing and community

See the contributing guidelines and theCommunity section of the homepage.