GitHub - prometheus/client_golang: Prometheus instrumentation library for Go applications (original) (raw)

Prometheus Go client library

CI Go Report Card Go Reference OpenSSF Scorecard Slack

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.

Version Compatibility

This library supports the three 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.

Note

See our Release Process for details on compatibility and support policies.

Important note about releases and stability

This repository generally follows Semantic Versioning. However, the API client inprometheus/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, but plans for further development of v2 at the moment.

NOTE: The initial v2 attempt is in a separate branch. We also started experimenting on a new prometheus.V2.* APIs in the 1.x's V2 struct. Help wanted!

Instrumenting applications

Go Reference

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

Go Reference

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.

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