metrics: add metrics and telemetry package (#500)

Author: arekkas

.travis.yml

@@ -2,6 +2,12 @@ sudo: required
 
 go_import_path: github.com/ory/hydra
 
+cache:
+  directories:
+    - $GOPATH/src
+    - $GOPATH/pkg
+    - ./vendor/
+
 services:
   - docker
 
@@ -25,14 +31,18 @@ install:
   - go install github.com/ory/hydra
 
 script:
-  - |-
-    touch ./coverage.tmp && echo 'mode: atomic' > coverage.txt && go list ./... | grep -v /vendor | xargs -n1 -I{} sh -c 'go test -covermode=atomic -coverprofile=coverage.tmp -coverpkg $(go list ./... | grep -v /vendor | tr "\n" ",") {} && tail -n +2 coverage.tmp >> coverage.txt' && rm coverage.tmp
+  - touch ./coverage.tmp
+  - |
+    echo 'mode: atomic' > coverage.txt
+  - |
+    go list ./... | grep -v /cmd | grep -v /vendor | xargs -n1 -I{} sh -c 'go test -race -covermode=atomic -coverprofile=coverage.tmp -coverpkg $(go list ./... | grep -v /vendor | tr "\n" ",") {} && tail -n +2 coverage.tmp >> coverage.txt || exit 255' && rm coverage.tmp
+  - touch ./coverage.tmp
+  - |
+    go list ./cmd/... | xargs -n1 -I{} sh -c 'go test -covermode=atomic -coverprofile=coverage.tmp -coverpkg $(go list ./... | grep -v /vendor | tr "\n" ",") {} && tail -n +2 coverage.tmp >> coverage.txt || exit 255' && rm coverage.tmp
   - goveralls -coverprofile="coverage.txt"
-  - go test -race $(go list ./... | grep -v /vendor | grep -v /cmd)
-  - go test -v -bench=.* -run=none $(glide novendor)
-  - docker build -t hydra-travis-ci .
+  - docker build -t hydra-travis-ci -f Dockerfile-without-telemetry .
   - docker run -d hydra-travis-ci
-  - DATABASE_URL=memory hydra host --dangerous-auto-logon --dangerous-force-http &
+  - DATABASE_URL=memory hydra host --dangerous-auto-logon --dangerous-force-http --disable-telemetry &
   - while ! echo exit | nc localhost 4444; do sleep 1; done
 # Test clients
   - hydra clients create --id foobar

Dockerfile-demo

@@ -10,6 +10,6 @@ RUN glide install --skip-test -v
 ADD . .
 RUN go install .
 
-ENTRYPOINT /go/bin/hydra migrate sql $DATABASE_URL; /go/bin/hydra host --dangerous-auto-logon --dangerous-force-http
+ENTRYPOINT /go/bin/hydra migrate sql $DATABASE_URL; /go/bin/hydra host --dangerous-auto-logon --dangerous-force-http --disable-telemetry
 
 EXPOSE 4444

Dockerfile-without-telemetry

@@ -0,0 +1,16 @@
+FROM golang:1.8-alpine
+
+RUN apk add --no-cache git
+RUN go get github.com/Masterminds/glide
+WORKDIR /go/src/github.com/ory/hydra
+
+ADD ./glide.yaml ./glide.yaml
+ADD ./glide.lock ./glide.lock
+RUN glide install --skip-test -v
+
+ADD . .
+RUN go install .
+
+ENTRYPOINT /go/bin/hydra host --disable-telemetry
+
+EXPOSE 4444

HISTORY.md

@@ -2,6 +2,11 @@
 
 This list makes you aware of (breaking) changes. For patch notes, please check the [releases tab](https://github.com/ory/hydra/releases).
 
+## 0.9.0
+
+This version adds performance metrics to `/health` and sends anonymous usage statistics to our servers, [click here](https://ory.gitbooks.io/hydra/content/telemetry.html) for more
+details on this feature and how to disable it.
+
 ## 0.8.0
 
 This PR improves some performance bottlenecks, offers more control over Hydra, moves to Go 1.8,

README.md

@@ -51,6 +51,7 @@ community on [Gitter](https://gitter.im/ory-am/hydra). For advanced use cases, c
     - [Using Docker](#using-docker)
     - [Building from source](#building-from-source)
 - [Security](#security)
+- [Telemetry](#telemetry)
 - [Documentation](#documentation)
   - [Guide](#guide)
   - [HTTP API documentation](#http-api-documentation)
@@ -218,6 +219,11 @@ ORY Hydra is trusted by companies all around the world, has a vibrant community
 each day. Of course, we also compiled a security guide with more details on cryptography and security concepts.
 Read [the security guide now](https://ory.gitbooks.io/hydra/content/security.html).
 
+## Telemetry
+
+ORY Hydra collects summarized, anonymized telemetry which can optionally be turned off. Click [here](https://ory.gitbooks.io/hydra/content/telemetry.html)
+to learn more.
+
 ## Documentation
 
 ### Guide

client/handler.go

@@ -6,9 +6,9 @@ import (
 	"net/http"
 
 	"github.com/julienschmidt/httprouter"
-	"github.com/ory/hydra/rand/sequence"
 	"github.com/ory/herodot"
 	"github.com/ory/hydra/firewall"
+	"github.com/ory/hydra/rand/sequence"
 	"github.com/ory/ladon"
 	"github.com/pkg/errors"
 )

client/manager_http.go

@@ -12,9 +12,9 @@ import (
 )
 
 type HTTPManager struct {
-	Client   *http.Client
-	Endpoint *url.URL
-	Dry      bool
+	Client             *http.Client
+	Endpoint           *url.URL
+	Dry                bool
 	FakeTLSTermination bool
 }
 

client/manager_sql.go

@@ -1,10 +1,10 @@
 package client
 
 import (
+	"context"
 	"database/sql"
 	"fmt"
 	"strings"
-	"context"
 
 	"github.com/jmoiron/sqlx"
 	"github.com/ory/fosite"

client/manager_test.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/julienschmidt/httprouter"
 	_ "github.com/lib/pq"
+	"github.com/ory/dockertest"
 	"github.com/ory/fosite"
 	"github.com/ory/herodot"
 	. "github.com/ory/hydra/client"
@@ -19,7 +20,6 @@ import (
 	"github.com/ory/hydra/pkg"
 	"github.com/ory/ladon"
 	"github.com/stretchr/testify/assert"
-	"github.com/ory/dockertest"
 )
 
 var clientManagers = map[string]Storage{}

cmd/cli/handler_warden.go

@@ -23,8 +23,8 @@ func newWardenHandler(c *config.Config) *WardenHandler {
 
 func (h *WardenHandler) IsAuthorized(cmd *cobra.Command, args []string) {
 	m := &oauth2.HTTPIntrospector{
-		Endpoint:           h.Config.Resolve("/oauth2/introspect"),
-		Client:             h.Config.OAuth2Client(cmd),
+		Endpoint: h.Config.Resolve("/oauth2/introspect"),
+		Client:   h.Config.OAuth2Client(cmd),
 	}
 
 	if len(args) != 1 {