Browse Source

Merge branch 'master' of git://github.com/AlekSi/go-metrics

Richard Crowley 12 years ago
parent
commit
f1df2bb021
2 changed files with 13 additions and 1 deletions
  1. 12 0
      registry.go
  2. 1 1
      timer.go

+ 12 - 0
registry.go

@@ -8,10 +8,19 @@ import "sync"
 // This is an interface so as to encourage other structs to implement
 // the Registry API as appropriate.
 type Registry interface {
+	// Call the given function for each registered metric.
 	Each(func(string, interface{}))
+
+	// Get the metric by the given name or nil if none is registered.
 	Get(string) interface{}
+
+	// Register the given metric under the given name.
 	Register(string, interface{})
+
+	// Run all registered healthchecks.
 	RunHealthchecks()
+
+	// Unregister the metric with the given name.
 	Unregister(string)
 }
 
@@ -22,6 +31,9 @@ type StandardRegistry struct {
 	metrics map[string]interface{}
 }
 
+// Check interface.
+var _ Registry = &StandardRegistry{}
+
 // Create a new registry.
 func NewRegistry() *StandardRegistry {
 	return &StandardRegistry{

+ 1 - 1
timer.go

@@ -5,7 +5,7 @@ import "time"
 // Timers capture the duration and rate of events.
 //
 // This is an interface so as to encourage other structs to implement
-// the Histogram API as appropriate.
+// the Timer API as appropriate.
 type Timer interface {
 	Count() int64
 	Max() int64