Prometheus instrumentation library for Go applications

Go to file

Björn Rabenstein 5f202eefdb Merge pull request #1150 from prometheus/sparsehistogram Merge sparsehistogram branch into main		2022-10-31 16:55:36 +01:00
.circleci	Update minimum supported Go version (#1062 )	2022-06-05 10:01:13 +02:00
.github	Update common Prometheus files (#1111 )	2022-08-05 22:38:30 +02:00
api	fix assorted oddities found by golangci-lint (#1040 )	2022-08-03 06:30:51 +02:00
examples	Merge branch 'main' into sparsehistogram	2022-10-31 16:30:59 +01:00
prometheus	Merge branch 'main' into sparsehistogram	2022-10-31 16:30:59 +01:00
scripts	Enable same linters as the Prometheus repo itself (#1056 )	2022-06-17 09:04:06 +02:00
.gitignore	prometheus: Fix convention violating names for generated collector metrics (#1048 )	2022-05-13 10:42:43 +02:00
.go-version	Generate new Go runtime metrics for go 1.19 (#1105 )	2022-08-05 15:48:33 +02:00
.golangci.yml	fix assorted oddities found by golangci-lint (#1040 )	2022-08-03 06:30:51 +02:00
CHANGELOG.md	Cut 1.13.0 (#1110 )	2022-08-05 20:31:42 +02:00
CODE_OF_CONDUCT.md	Update common Prometheus files (#1045 )	2022-05-05 07:46:54 +02:00
CONTRIBUTING.md	Mention the DCO in the contributing guide	2018-05-31 14:22:30 +00:00
Dockerfile	prometheus: Fix convention violating names for generated collector metrics (#1048 )	2022-05-13 10:42:43 +02:00
LICENSE	License cleanup	2015-01-22 16:13:15 +01:00
MAINTAINERS.md	Change maintainers from @beorn7 to @bwplotka/@kakkoyun (#873 )	2021-06-01 14:13:09 +01:00
Makefile	Generate new Go runtime metrics for go 1.19 (#1105 )	2022-08-05 15:48:33 +02:00
Makefile.common	Update common Prometheus files (#1064 )	2022-06-14 00:19:38 +02:00
NOTICE	Create a public registry interface and separate out HTTP exposition	2016-08-02 18:46:22 +02:00
README.md	Update minimum supported Go version (#1062 )	2022-06-05 10:01:13 +02:00
SECURITY.md	Update common Prometheus files (#1045 )	2022-05-05 07:46:54 +02:00
VERSION	Cut 1.13.0 (#1110 )	2022-08-05 20:31:42 +02:00
go.mod	Update prometheus/client_model dependency	2022-10-19 18:27:50 +02:00
go.sum	Update prometheus/client_model dependency	2022-10-19 18:27:50 +02:00

README.md

Prometheus Go client library

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.17 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

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

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.

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