mirror
/
client_golang
mirror of https://github.com/prometheus/client_golang.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
Prometheus instrumentation library for Go applications
1,351 Commits 29 Branches 52 Tags 23 MiB
Go 99.2%
Makefile 0.3%
C 0.3%
Dockerfile 0.1%
Go to file
bwplotka 078f11f85b Cut 1.13.1 release (+ documenting release process). 
Signed-off-by: bwplotka <bwplotka@gmail.com>
 		2022-11-01 16:37:13 +00:00
.circleci Update minimum supported Go version (#1062) 2022-06-05 10:01:13 +02:00
.github Generate new Go runtime metrics for go 1.19 (#1105) 2022-08-05 15:48:33 +02:00
api fix assorted oddities found by golangci-lint (#1040) 2022-08-03 06:30:51 +02:00
examples prometheus: Fix convention violating names for generated collector metrics (#1048) 2022-05-09 10:33:45 +02:00
prometheus Fix race condition with Exemplar in Counter (#1146) 2022-11-01 16:22:27 +00: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-09 10:33:45 +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.1 release (+ documenting release process). 2022-11-01 16:37:13 +00: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-09 10:33:45 +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 Cut 1.13.1 release (+ documenting release process). 2022-11-01 16:37:13 +00:00
SECURITY.md Update common Prometheus files (#1045) 2022-05-05 07:46:54 +02:00
VERSION Cut 1.13.1 release (+ documenting release process). 2022-11-01 16:37:13 +00:00
go.mod Bump github.com/prometheus/procfs from 0.7.3 to 0.8.0 (#1097) 2022-08-02 10:43:54 +02:00
go.sum Bump github.com/prometheus/procfs from 0.7.3 to 0.8.0 (#1097) 2022-08-02 10:43:54 +02: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.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

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.

For Maintainers: Release Process

To cut minor version:

  1. Create new branch release-<major>.<minor> on top of main commit you want to cut version from and push it.
  2. Create new branch on top of release branch.
  3. Change VERSION file.
  4. Update CHANGELOG (only user-impacting changes to mention).
  5. Create PR, get it reviewed.
  6. Once merged, create release for release-<major>.<minor> tag on GitHub with <version> / <date> title.
  7. Announce on prometheus-announce mailing list, slack and Twitter.
  8. Merge release branch back to main using "merge without squashing" approach (!).

To cut patch version:

  1. Create branch on top of release branch you want to use.
  2. Cherry-pick fixes from main or add commits to fix critical bugs only for that patch release.
  3. Follow steps 3-8 as above.