re
/
client_golang
forked from mirror/client_golang
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Prometheus instrumentation library for Go applications
1,287 Commits 9 Branches 39 Tags 10 MiB
Go 99.7%
Dockerfile 0.2%
Makefile 0.1%
Go to file
Bartlomiej Plotka 06b641214c
Added info about our slack channel. (#1029) 		2022-04-12 16:24:39 +02:00
.circleci .circleci: Add config to test against go1.18 (#1006) 2022-03-17 15:34:12 +00:00
.github Update common Prometheus files 2022-03-31 19:50:35 +00:00
api Refactor apiClientImpl.DoGetFallback 2022-04-07 09:18:32 +02:00
examples Fix deprecated `NewBuildInfoCollector` API 2022-03-16 17:46:48 +08:00
prometheus Remove workaround for pre go1.15 (#1010) 2022-03-27 19:11:56 +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 Cut v1.12.1 (#978) 2022-01-29 15:48:34 +01: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 Update Dockerfile example 2022-03-16 18:14:51 +08: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 2022-03-31 19:50:35 +00:00
NOTICE Create a public registry interface and separate out HTTP exposition 2016-08-02 18:46:22 +02:00
README.md Added info about our slack channel. (#1029) 2022-04-12 16:24:39 +02:00
SECURITY.md Add SECURITY.md 2021-01-16 13:57:42 +01:00
VERSION Cut v1.12.1 (#978) 2022-01-29 15:48:34 +01:00
go.mod go.mod: Update dependencies (#1018) 2022-03-29 14:15:42 +01:00
go.sum go.mod: Update dependencies (#1018) 2022-03-29 14:15:42 +01:00

README.md

Prometheus Go client library

CircleCI Go Report Card Go Reference Slack

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

code-coverage Go Reference

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 Reference

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.