Release 1.0.0

Author: danielgtaylor

CHANGELOG.md

@@ -6,4 +6,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+- Add items here as needed.
+
+## [1.0.0] - 2017-07-26
+
 - Make project public on GitHub.

README.md

@@ -1,6 +1,6 @@
 # Metrics Library for Go
 
-[![Travis](https://img.shields.io/travis/istreamlabs/go-metrics.svg)](https://travis-ci.org/istreamlabs/go-metrics) [![Codecov](https://img.shields.io/codecov/c/github/istreamlabs/go-metrics.svg)](https://codecov.io/gh/istreamlabs/go-metrics) [![GitHub tag](https://img.shields.io/github/tag/istreamlabs/go-metrics.svg)](https://github.com/istreamlabs/go-metrics/releases) [![License](https://img.shields.io/github/license/istreamlabs/go-metrics.svg)](https://github.com/istreamlabs/go-metrics/blob/master/LICENSE)
+[![Travis](https://img.shields.io/travis/istreamlabs/go-metrics.svg)](https://travis-ci.org/istreamlabs/go-metrics) [![Codecov](https://img.shields.io/codecov/c/github/istreamlabs/go-metrics.svg)](https://codecov.io/gh/istreamlabs/go-metrics) [![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/istreamlabs/go-metrics/metrics) [![GitHub tag](https://img.shields.io/github/tag/istreamlabs/go-metrics.svg)](https://github.com/istreamlabs/go-metrics/releases) [![License](https://img.shields.io/github/license/istreamlabs/go-metrics.svg)](https://github.com/istreamlabs/go-metrics/blob/master/LICENSE)
 
 A library that provides an interface for sending metrics from your script, application, or service. Metrics consist of a name, value, and optionally some tags that are made up of key/value pairs.
 
@@ -22,15 +22,21 @@ Generally you will instantiate one of the above clients and then write metrics t
 dep ensure github.com/istreamlabs/go-metrics
 
 # Otherwise, just go get it:
-go get github.com/istreamlabs/go-metrics
+go get github.com/istreamlabs/go-metrics/metrics
 ```
 
 Then you can use it:
 
 ```go
-import "github.com/istreamlabs/go-metrics"
-
-client := metrics.NewDataDogClient("127.0.0.1:8125", "myprefix")
+import "github.com/istreamlabs/go-metrics/metrics"
+
+var client metrics.Client
+if os.Getenv("env") == "prod" {
+  client = metrics.NewDataDogClient("127.0.0.1:8125", "myprefix")
+} else {
+  // Log to standard out instead of sending production metrics.
+  client = metrics.NewLoggerClient(nil)
+}
 
 // Simple incrementing counter
 client.Incr("requests.count")
@@ -41,7 +47,7 @@ client.WithTags(map[string]string{
 }).Incr("requests.count")
 ```
 
-The above code would result in `myprefix.requests.count` with a value of `1` showing up in DataDog if you have [`dogstatsd`](https://docs.datadoghq.com/guides/dogstatsd/) running locally. See the [`Client`](https://godoc.org/github.com/istreamlabs/go-metrics/#Client) interface for a list of available metrics methods.
+The above code would result in `myprefix.requests.count` with a value of `1` showing up in DataDog if you have [`dogstatsd`](https://docs.datadoghq.com/guides/dogstatsd/) running locally and an environment variable `env` set to `prod`, otherwise it will print metrics to standard out. See the [`Client`](https://godoc.org/github.com/istreamlabs/go-metrics/metrics/#Client) interface for a list of available metrics methods.
 
 Also provided are useful clients for testing. For example, the following asserts that a metric with the given name, value, and tag was emitted during a test:
 
@@ -61,7 +67,7 @@ func TestFoo(t *testing.T)
 }
 ```
 
-For more information and examples, see the [godocs](https://godoc.org/github.com/istreamlabs/go-metrics/).
+For more information and examples, see the [godocs](https://godoc.org/github.com/istreamlabs/go-metrics/metrics).
 
 ## License
 

client.go renamed to metrics/client.go

@@ -6,6 +6,8 @@
 // development, and testing use cases. Generally you will instantiate one
 // of these clients and then write metrics to it:
 //
+//   import "github.com/istreamlabs/go-metrics/metrics"
+//
 //   client := metrics.NewDataDogClient("127.0.0.1:8125", "myprefix")
 //
 //   // Simple incrementing counter

datadog.go renamed to metrics/datadog.go

@@ -6,7 +6,7 @@ import (
 	"time"
 
 	"github.com/DataDog/datadog-go/statsd"
-	"github.com/istreamlabs/go-metrics"
+	"github.com/istreamlabs/go-metrics/metrics"
 )
 
 func ExampleDataDogClient() {

datadog_test.go renamed to metrics/datadog_test.go

@@ -6,7 +6,7 @@ import (
 	"time"
 
 	"github.com/DataDog/datadog-go/statsd"
-	"github.com/istreamlabs/go-metrics"
+	"github.com/istreamlabs/go-metrics/metrics"
 )
 
 // LogRecorder dumps log messages into an array.

export_test.go renamed to metrics/export_test.go

@@ -0,0 +1,35 @@
+package metrics_test
+
+import (
+	"testing"
+	"time"
+
+	"github.com/DataDog/datadog-go/statsd"
+	"github.com/istreamlabs/go-metrics/metrics"
+)
+
+func ExampleNullClient() {
+	client := metrics.NewNullClient()
+	client.WithTags(map[string]string{
+		"tag1": "value1",
+		"tag2": "value2",
+	}).Incr("requests.count")
+	client.Incr("other")
+
+	// Output:
+}
+
+func TestNullClientMethods(t *testing.T) {
+	client := metrics.NewNullClient()
+
+	client.Incr("count")
+	client.Decr("count")
+	client.Count("count", 5)
+
+	client.Gauge("gauge", 10)
+
+	client.Histogram("histo", 1.25)
+	client.Timing("timing", time.Duration(123))
+
+	client.Event(&statsd.Event{})
+}