Prometheus instrumentation library for Go applications
Go to file
beorn7 08104a0ef9 Minor doc comment fixes
Signed-off-by: beorn7 <beorn@grafana.com>
2021-01-29 22:24:27 +01:00
.circleci Add Circle CI configuration 2020-02-28 11:59:41 +01:00
.github Release v0.9.0 2018-10-15 13:28:28 +02:00
api Address review feedback 2020-02-28 09:49:39 +00:00
examples Demo sparse histograms 2020-04-07 23:18:09 +02:00
prometheus Minor doc comment fixes 2021-01-29 22:24:27 +01:00
.gitignore Update .gitignore 2019-07-30 23:07:13 +02:00
.golangci.yml Add .golangci.yml 2019-04-25 10:38:07 +02:00
.travis.yml Enable Go 1.13 2019-09-13 12:13:46 +02:00
CHANGELOG.md Cut v1.5.0 2020-03-03 16:48:32 +01:00
CONTRIBUTING.md Mention the DCO in the contributing guide 2018-05-31 14:22:30 +00:00
Dockerfile add minor Dockerfile improvements 2019-07-31 09:13:29 -07:00
LICENSE License cleanup 2015-01-22 16:13:15 +01:00
MAINTAINERS.md rmeove Krasi from the maintainers. 2019-10-22 01:50:42 +03:00
Makefile Update Makefile.common 2019-03-13 09:43:07 +01:00
Makefile.common makefile: update Makefile.common with newer version 2020-02-25 00:08:30 +00:00
NOTICE Create a public registry interface and separate out HTTP exposition 2016-08-02 18:46:22 +02:00
README.md Fix typo 2019-12-04 21:11:33 +01:00
VERSION Cut v1.5.0 2020-03-03 16:48:32 +01:00
go.mod Encode sparse histograms in protobuf 2020-04-07 23:18:40 +02:00
go.sum Encode sparse histograms in protobuf 2020-04-07 23:18:40 +02:00

README.md

Prometheus Go client library

Build Status Go Report Card go-doc

This is the Go client library for Prometheus. 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. The minimum required patch releases for older Go versions are Go1.9.7 and Go1.10.3.

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

code-coverage go-doc

The prometheus directory contains the instrumentation library. See the guide on the Prometheus website to learn more about instrumenting applications.

The examples directory contains simple examples of instrumented code.

Client for the Prometheus HTTP API

code-coverage go-doc

The api/prometheus directory contains the client for the Prometheus 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 to prometheus/common/model.

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

Contributing and community

See the contributing guidelines and the Community section of the homepage.