re
/
client_golang
forked from mirror/client_golang
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
client_golang/prometheus
History
beorn7 663a9ad019 Make Help strings optional 
This is in line with
https://prometheus.io/docs/instrumenting/writing_clientlibs/#metric-description-and-help

Since the zero value of a string in Go is `""`, we cannot distinguish
between a Help string not set and an empty Help string. Thus, we just
make it formally optional here with an encouragement to set it in the
doc comment.

In v0.10, the Help string will probably become a "normal" argument of
the constructor rather than a field in an Opts struct.

Signed-off-by: beorn7 <beorn@soundcloud.com>
 		2018-09-17 12:07:31 +02:00
..
graphite Add missing license headers 2018-08-22 13:53:56 +02:00
internal Create an internal package 2018-09-03 00:18:11 +02:00
promauto promauto: add NewCounterFunc and NewGaugeFunc 2018-03-17 14:01:36 -07:00
promhttp forgot some &s 2018-07-13 09:28:19 -04:00
push Fix typos 2018-04-13 23:23:52 +02:00
testutil Add package documentation 2018-09-04 14:02:20 +02:00
.gitignore Rearrange file and package per convention. 2013-04-04 15:27:09 +02:00
README.md Create a public registry interface and separate out HTTP exposition 2016-08-02 18:46:22 +02:00
benchmark_test.go Add a benchmark for concurrent counter increments 2018-01-19 15:15:10 -08:00
collector.go Update Collector example 2018-09-12 15:34:13 +02:00
collector_test.go Add a DescribeByCollect helper 2018-09-05 14:10:51 +02:00
counter.go Iterate on a proposed performance improvement for counters 2018-01-19 19:06:43 +01:00
counter_test.go Iterate on a proposed performance improvement for counters 2018-01-19 19:06:43 +01:00
desc.go Make Help strings optional 2018-09-17 12:07:31 +02:00
desc_test.go Add missing license headers 2018-08-22 13:53:56 +02:00
doc.go Introduce unchecked Collectors 2018-07-09 14:33:18 +02:00
example_clustermanager_test.go Rename WrapWith... to WrapRegistererWith... 2018-09-13 17:43:05 +02:00
example_timer_complex_test.go fix spelling typo 2017-08-28 08:57:51 +08:00
example_timer_gauge_test.go Fix invalid Timer (gauge) example 2017-02-28 11:13:17 -04:00
example_timer_test.go Change the Timer API 2016-11-18 20:32:18 +01:00
examples_test.go Make Help strings optional 2018-09-17 12:07:31 +02:00
expvar_collector.go Create a public registry interface and separate out HTTP exposition 2016-08-02 18:46:22 +02:00
expvar_collector_test.go Simplify if expr in ExampleNewExpvarCollector() 2018-04-13 23:23:52 +02:00
fnv.go Add missing license headers 2018-08-22 13:53:56 +02:00
gauge.go Iterate on a proposed performance improvement for counters 2018-01-19 19:06:43 +01:00
gauge_test.go Iterate on a proposed performance improvement for counters 2018-01-19 19:06:43 +01:00
go_collector.go Add missing license headers 2018-08-22 13:53:56 +02:00
go_collector_test.go Add missing license headers 2018-08-22 13:53:56 +02:00
histogram.go Make Help strings optional 2018-09-17 12:07:31 +02:00
histogram_test.go Make Histogram observations atomic while keeping them lock-free 2018-09-12 15:03:44 +02:00
http.go Reformat doc comment of InstrumentHandler 2018-09-14 13:24:05 +02:00
http_test.go Fix three shadow variable warnings (govet -shadow) 2018-04-13 23:25:14 +02:00
labels.go Add missing license headers 2018-08-22 13:53:56 +02:00
metric.go Make Help strings optional 2018-09-17 12:07:31 +02:00
metric_test.go Change "Prometheus Team" to "The Prometheus Authors". 2015-02-02 15:14:36 +01:00
observer.go Pull currying methods up into ObserverVec interface 2017-12-22 16:11:58 +01:00
process_collector.go Rework process collector 2018-09-07 12:09:26 +02:00
process_collector_test.go Rework process collector 2018-09-07 12:09:26 +02:00
registry.go Add wrapping of Registerers with labels and prefix 2018-09-12 15:34:07 +02:00
registry_test.go Add suffix collision checks during gathering 2018-07-13 16:29:17 +02:00
summary.go Make Help strings optional 2018-09-17 12:07:31 +02:00
summary_test.go Check quantile label during SummaryVec construction 2018-07-13 13:43:21 +02:00
timer.go Document the use of Go1.9+ for monotonic time where applicable 2017-06-29 16:07:12 +02:00
timer_test.go new handler instrumentation (#285) 2017-04-24 15:13:19 -04:00
untyped.go Remove the deprecated uses of Untyped metrics 2017-08-29 17:31:45 +02:00
value.go Let NewConst... functions detect invalid Desc 2018-09-17 11:50:42 +02:00
value_test.go Add missing license headers 2018-08-22 13:53:56 +02:00
vec.go Fix unprotected write in metricMap 2018-04-09 10:10:15 -04:00
vec_test.go Allow currying of metric vec's 2017-12-22 15:56:11 +01:00
wrap.go Discourage prefixing every metris with WrapRegistererWithPrefix 2018-09-14 11:59:13 +02:00
wrap_test.go Rename WrapWith... to WrapRegistererWith... 2018-09-13 17:43:05 +02:00

README.md

See go-doc.