Use relay/http/* as metric name prefix

Author: Zack Lin

Diff for: metric/metric.go

@@ -9,24 +9,20 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 	"go.opencensus.io/plugin/ochttp"
 	"go.opencensus.io/stats/view"
-	"go.opencensus.io/tag"
 )
 
 const (
 	defaultAddr              = ":8088"
 	defaultShutdownTimeoutMs = 5000
 )
 
+// Server represents a metric server serves /metrics endpoint
 type Server struct {
 	h  *http.Server
 	pe *ocprom.Exporter
 }
 
-func init() {
-	registerDefaultServerViews()
-	registerDefaultClientViews()
-}
-
+// Run launchs the metric server
 func (s *Server) Run() error {
 	mux := http.NewServeMux()
 	mux.Handle("/metrics", s.pe)
@@ -38,12 +34,14 @@ func (s *Server) Run() error {
 	return nil
 }
 
+// Stop stops the metric server gracefully
 func (s *Server) Stop() error {
 	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*defaultShutdownTimeoutMs)
 	defer cancel()
 	return s.h.Shutdown(ctx)
 }
 
+// NewServer returns a metric server
 func NewServer() (*Server, error) {
 	promExporter, err := ocprom.NewExporter(
 		ocprom.Options{
@@ -61,51 +59,16 @@ func NewServer() (*Server, error) {
 	}, nil
 }
 
+// HTTPHandler returns a http.Handler wrapper that instruments given HTTP server's handler
 func HTTPHandler(h http.Handler) http.Handler {
 	return &ochttp.Handler{
 		Handler: h,
 	}
 }
 
+// HTTPTransport returns a http.RoundTripper wrapper that instruments all outgoing requests from base
 func HTTPTransport(base *http.Transport) http.RoundTripper {
 	return &ochttp.Transport{
 		Base: base,
 	}
 }
-
-func registerDefaultServerViews() {
-	views := []*view.View{
-		ochttp.ServerRequestCountView,
-		ochttp.ServerRequestBytesView,
-		ochttp.ServerResponseBytesView,
-		ochttp.ServerLatencyView,
-		ochttp.ServerRequestCountByMethod,
-		ochttp.ServerResponseCountByStatusCode,
-	}
-	for _, view := range views {
-		view.TagKeys = []tag.Key{
-			ochttp.Path,
-			ochttp.Method,
-			ochttp.StatusCode,
-		}
-	}
-	view.Register(views...)
-}
-
-func registerDefaultClientViews() {
-	views := []*view.View{
-		ochttp.ClientSentBytesDistribution,
-		ochttp.ClientReceivedBytesDistribution,
-		ochttp.ClientRoundtripLatencyDistribution,
-		ochttp.ClientCompletedCount,
-	}
-	for _, view := range views {
-		view.TagKeys = []tag.Key{
-			ochttp.KeyClientHost,
-			ochttp.KeyClientPath,
-			ochttp.KeyClientMethod,
-			ochttp.KeyClientStatus,
-		}
-	}
-	view.Register(views...)
-}

Diff for: metric/view.go

@@ -0,0 +1,95 @@
+package metric
+
+import (
+	"go.opencensus.io/plugin/ochttp"
+	"go.opencensus.io/stats/view"
+	"go.opencensus.io/tag"
+)
+
+var (
+	defaultSizeDistribution    = view.Distribution(1024, 2048, 4096, 16384, 65536, 262144, 1048576, 4194304, 16777216, 67108864, 268435456, 1073741824, 4294967296)
+	defaultLatencyDistribution = view.Distribution(1, 2, 3, 4, 5, 6, 8, 10, 13, 16, 20, 25, 30, 40, 50, 65, 80, 100, 130, 160, 200, 250, 300, 400, 500, 650, 800, 1000, 2000, 5000, 10000, 20000)
+)
+
+var (
+	httpViews = []*view.View{
+		&view.View{
+			Name:        "relay/http/request_count",
+			Description: "Count of HTTP requests started",
+			TagKeys:     []tag.Key{ochttp.Path, ochttp.Method, ochttp.StatusCode},
+			Measure:     ochttp.ServerRequestCount,
+			Aggregation: view.Count(),
+		},
+		&view.View{
+			Name:        "relay/http/request_bytes",
+			Description: "Size distribution of HTTP request body",
+			TagKeys:     []tag.Key{ochttp.Path, ochttp.Method, ochttp.StatusCode},
+			Measure:     ochttp.ServerRequestBytes,
+			Aggregation: defaultSizeDistribution,
+		},
+		&view.View{
+			Name:        "relay/http/response_bytes",
+			Description: "Size distribution of HTTP response body",
+			TagKeys:     []tag.Key{ochttp.Path, ochttp.Method, ochttp.StatusCode},
+			Measure:     ochttp.ServerResponseBytes,
+			Aggregation: defaultSizeDistribution,
+		},
+		&view.View{
+			Name:        "relay/http/latency",
+			Description: "Latency distribution of HTTP requests",
+			TagKeys:     []tag.Key{ochttp.Path, ochttp.Method, ochttp.StatusCode},
+			Measure:     ochttp.ServerLatency,
+			Aggregation: defaultLatencyDistribution,
+		},
+		&view.View{
+			Name:        "relay/http/request_count_by_method",
+			Description: "Server request count by HTTP method",
+			TagKeys:     []tag.Key{ochttp.Path, ochttp.Method, ochttp.StatusCode},
+			Measure:     ochttp.ServerRequestCount,
+			Aggregation: view.Count(),
+		},
+		&view.View{
+			Name:        "relay/http/response_count_by_status_code",
+			Description: "Server response count by status code",
+			TagKeys:     []tag.Key{ochttp.Path, ochttp.Method, ochttp.StatusCode},
+			Measure:     ochttp.ServerLatency,
+			Aggregation: view.Count(),
+		},
+	}
+
+	httpOutputViews = []*view.View{
+		&view.View{
+			Name:        "relay/http/output/sent_bytes",
+			Description: "Total bytes sent in request body (not including headers), by HTTP method and response status",
+			TagKeys:     []tag.Key{ochttp.KeyClientHost, ochttp.KeyClientPath, ochttp.KeyClientMethod, ochttp.KeyClientStatus},
+			Measure:     ochttp.ClientSentBytes,
+			Aggregation: defaultSizeDistribution,
+		},
+		&view.View{
+			Name:        "relay/http/output/received_bytes",
+			Description: "Total bytes received in response bodies (not including headers but including error responses with bodies), by HTTP method and response status",
+			TagKeys:     []tag.Key{ochttp.KeyClientHost, ochttp.KeyClientPath, ochttp.KeyClientMethod, ochttp.KeyClientStatus},
+			Measure:     ochttp.ClientReceivedBytes,
+			Aggregation: defaultSizeDistribution,
+		},
+		&view.View{
+			Name:        "relay/http/output/latency",
+			Description: "End-to-end latency, by HTTP method and response status",
+			TagKeys:     []tag.Key{ochttp.KeyClientHost, ochttp.KeyClientPath, ochttp.KeyClientMethod, ochttp.KeyClientStatus},
+			Measure:     ochttp.ClientRoundtripLatency,
+			Aggregation: defaultSizeDistribution,
+		},
+		&view.View{
+			Name:        "relay/http/output/completed_count",
+			Description: "Count of completed requests, by HTTP method and response status",
+			TagKeys:     []tag.Key{ochttp.KeyClientHost, ochttp.KeyClientPath, ochttp.KeyClientMethod, ochttp.KeyClientStatus},
+			Measure:     ochttp.ClientRoundtripLatency,
+			Aggregation: view.Count(),
+		},
+	}
+)
+
+func init() {
+	view.Register(httpViews...)
+	view.Register(httpOutputViews...)
+}