From 552bef44bd9268fe6f1c4094bbf9f1ec787a7483 Mon Sep 17 00:00:00 2001 From: "Matt T. Proud" Date: Mon, 18 Feb 2013 09:30:47 -0600 Subject: [PATCH 1/2] Run gofmt on corpus and include deprecation. --- contributor/documentation.go | 2 +- documentation/documentation.go | 2 +- documentation/styleguide.go | 2 +- registry.go | 8 +++++--- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/contributor/documentation.go b/contributor/documentation.go index fa6f707..7eace5f 100644 --- a/contributor/documentation.go +++ b/contributor/documentation.go @@ -6,4 +6,4 @@ // A repository of various contributed Prometheus client components that may // assist in your use of the library. -package contributor \ No newline at end of file +package contributor diff --git a/documentation/documentation.go b/documentation/documentation.go index 730e474..32265ae 100644 --- a/documentation/documentation.go +++ b/documentation/documentation.go @@ -5,4 +5,4 @@ // in the LICENSE file. // A repository of various Prometheus client documentation and advice. -package documentation \ No newline at end of file +package documentation diff --git a/documentation/styleguide.go b/documentation/styleguide.go index d63c2db..dfed6b0 100644 --- a/documentation/styleguide.go +++ b/documentation/styleguide.go @@ -45,4 +45,4 @@ // post-processing job. The same goes for archiving. I will need to evaluate // hooks into something like OpenTSBD. -package documentation \ No newline at end of file +package documentation diff --git a/registry.go b/registry.go index 7cf06d1..8c77310 100644 --- a/registry.go +++ b/registry.go @@ -50,7 +50,6 @@ type container struct { name string } - type registry struct { mutex sync.RWMutex signatureContainers map[string]container @@ -63,9 +62,12 @@ type registry struct { type Registry interface { // Register a metric with a given name. Name should be globally unique. Register(name, docstring string, baseLabels map[string]string, metric metrics.Metric) error -// Create a http.HandlerFunc that is tied to a Registry such that requests -// against it generate a representation of the housed metrics. + // Create a http.HandlerFunc that is tied to a Registry such that requests + // against it generate a representation of the housed metrics. Handler() http.HandlerFunc + // This is a legacy version of Handler and is deprecated. Please stop + // using. + YieldExporter() http.HandlerFunc } // This builds a new metric registry. It is not needed in the majority of From e47bd1785dd68e7b56829013fef21fa1dd09c1de Mon Sep 17 00:00:00 2001 From: "Matt T. Proud" Date: Thu, 28 Mar 2013 10:44:20 +0100 Subject: [PATCH 2/2] Include link to generated API documentation. Include mailing list. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e3e1fa..ea70317 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,12 @@ representation thereof. For instance, if a values therein is requested, it may situationally emit a minimum, maximum, an average, or any other reduction mechanism requested. +# Getting Started + + * The source code is periodically indexed: [Go Exposition Client](http://godoc.org/github.com/prometheus/client_golang). + * All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers). + + # Testing This package employs [gocheck](http://labix.org/gocheck) for testing. Please ensure that all tests pass by running the following from the project root: @@ -73,4 +79,4 @@ ensure that all tests pass by running the following from the project root: $ go test ./... The use of gocheck is summarily being phased out; however, old tests that use it -still exist. \ No newline at end of file +still exist.