Prometheus instrumentation library for Go applications

Go to file

Kemal Akkoyun 9075cdf616 promhttp: Check validity of method and code label values (#962 ) * Check validity of method and code label values Signed-off-by: Kemal Akkoyun <kakkoyun@gmail.com> * Use more flexibly functional option pattern for configuration Signed-off-by: Kemal Akkoyun <kakkoyun@gmail.com> * Update documentation Signed-off-by: Kemal Akkoyun <kakkoyun@gmail.com> * Simplify Signed-off-by: Kemal Akkoyun <kakkoyun@gmail.com> * Fix inconsistent method naming Signed-off-by: Kemal Akkoyun <kakkoyun@gmail.com>		2022-01-18 10:19:28 +01:00
.circleci	Update common Prometheus files	2021-12-20 20:51:20 +00:00
.github	Update common Prometheus files	2021-12-20 20:51:20 +00:00
api	Update /api/v1/status/tsdb to include headStats (#925 )	2022-01-05 10:09:29 +01:00
examples	Move flags and metrics into main()	2021-11-10 16:20:42 +01:00
prometheus	promhttp: Check validity of method and code label values (#962 )	2022-01-18 10:19:28 +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
CHANGELOG.md	Address minor issues on Changelog	2021-06-07 18:44:51 +02:00
CODE_OF_CONDUCT.md	Update common Prometheus files	2020-06-23 00:08:53 +00: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	Change maintainers from @beorn7 to @bwplotka/@kakkoyun (#873 )	2021-06-01 14:13:09 +01:00
Makefile	Add lint:ignore for protobuf deprecation	2020-05-14 20:11:22 +02:00
Makefile.common	Update common Prometheus files	2021-12-20 20:51:20 +00:00
NOTICE	Create a public registry interface and separate out HTTP exposition	2016-08-02 18:46:22 +02:00
README.md	Update status badgets	2021-06-23 10:12:43 +02:00
SECURITY.md	Add SECURITY.md	2021-01-16 13:57:42 +01:00
VERSION	Cut v1.11.0 (#877 )	2021-06-07 13:32:16 +01:00
go.mod	Update cespare/xxhash dependency (#913 )	2021-09-29 11:11:17 +01:00
go.sum	Update cespare/xxhash dependency (#913 )	2021-09-29 11:11:17 +01: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.13 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.