mirror
/
client_golang
mirror of https://github.com/prometheus/client_golang.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #583 from prometheus/beorn7/doc 

Remove outdated use-case description from doc comment
This commit is contained in:
Björn Rabenstein 2019-05-16 11:31:50 +02:00 committed by GitHub
parent 2827f2a8d9 e91cd81632
commit 0e198671c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
prometheus/examples_test.go
View File

@ -232,16 +232,11 @@ func ExampleRegister() {
// A different (and somewhat tricky) approach is to use
// ConstLabels. ConstLabels are pairs of label names and label values
// that never change. You might ask what those labels are good for (and
// rightfully so - if they never change, they could as well be part of
// the metric name). There are essentially two use-cases: The first is
// if labels are constant throughout the lifetime of a binary execution,
// but they vary over time or between different instances of a running
// binary. The second is what we have here: Each worker creates and
// registers an own Counter instance where the only difference is in the
// value of the ConstLabels. Those Counters can all be registered
// because the different ConstLabel values guarantee that each worker
// will increment a different Counter metric.
// that never change. Each worker creates and registers an own Counter
// instance where the only difference is in the value of the
// ConstLabels. Those Counters can all be registered because the
// different ConstLabel values guarantee that each worker will increment
// a different Counter metric.
counterOpts := prometheus.CounterOpts{
Subsystem: "worker_pool",
Name: "completed_tasks",