Define a new telemetry Stat API (#663)

* Define a new telemetry Stat API Proposal definition for a new Stat API, for the purposes of satisfying the queries proposed in #627. StatSummary will replace Stat once implemented and the original Stat deleted.
linkerd · Apr 3, 2018 · d1a39ea · d1a39ea
1 parent 06bf78c
commit d1a39ea
Show file tree

Hide file tree

Showing 6 changed files with 822 additions and 82 deletions.
diff --git a/controller/api/public/client.go b/controller/api/public/client.go
@@ -36,6 +36,13 @@ func (c *grpcOverHttpClient) Stat(ctx context.Context, req *pb.MetricRequest, _
 	return &msg, err
 }
 
+// TODO: This will replace Stat, once implemented
+func (c *grpcOverHttpClient) StatSummary(ctx context.Context, req *pb.StatSummaryRequest, _ ...grpc.CallOption) (*pb.StatSummaryResponse, error) {
+	var msg pb.StatSummaryResponse
+	err := c.apiRequest(ctx, "StatSummary", req, &msg)
+	return &msg, err
+}
+
 func (c *grpcOverHttpClient) Version(ctx context.Context, req *pb.Empty, _ ...grpc.CallOption) (*pb.VersionInfo, error) {
 	var msg pb.VersionInfo
 	err := c.apiRequest(ctx, "Version", req, &msg)

diff --git a/controller/api/public/grpc_server.go b/controller/api/public/grpc_server.go
@@ -119,6 +119,10 @@ func (s *grpcServer) Stat(ctx context.Context, req *pb.MetricRequest) (*pb.Metri
 	return &pb.MetricResponse{Metrics: metrics}, err
 }
 
+func (s *grpcServer) StatSummary(ctx context.Context, req *pb.StatSummaryRequest) (*pb.StatSummaryResponse, error) {
+	return &pb.StatSummaryResponse{}, nil
+}
+
 func (s *grpcServer) queryMetric(ctx context.Context, req *pb.MetricRequest, metric pb.MetricName) metricResult {
 
 	result := metricResult{}

diff --git a/controller/api/public/http_server_test.go b/controller/api/public/http_server_test.go
@@ -27,6 +27,11 @@ func (m *mockGrpcServer) Stat(ctx context.Context, req *pb.MetricRequest) (*pb.M
 	return m.ResponseToReturn.(*pb.MetricResponse), m.ErrorToReturn
 }
 
+func (m *mockGrpcServer) StatSummary(ctx context.Context, req *pb.StatSummaryRequest) (*pb.StatSummaryResponse, error) {
+	m.LastRequestReceived = req
+	return m.ResponseToReturn.(*pb.StatSummaryResponse), m.ErrorToReturn
+}
+
 func (m *mockGrpcServer) Version(ctx context.Context, req *pb.Empty) (*pb.VersionInfo, error) {
 	m.LastRequestReceived = req
 	return m.ResponseToReturn.(*pb.VersionInfo), m.ErrorToReturn

diff --git a/controller/api/public/test_helper.go b/controller/api/public/test_helper.go
@@ -11,18 +11,23 @@ import (
 )
 
 type MockConduitApiClient struct {
-	ErrorToReturn             error
-	VersionInfoToReturn       *pb.VersionInfo
-	ListPodsResponseToReturn  *pb.ListPodsResponse
-	MetricResponseToReturn    *pb.MetricResponse
-	SelfCheckResponseToReturn *healthcheckPb.SelfCheckResponse
-	Api_TapClientToReturn     pb.Api_TapClient
+	ErrorToReturn               error
+	VersionInfoToReturn         *pb.VersionInfo
+	ListPodsResponseToReturn    *pb.ListPodsResponse
+	MetricResponseToReturn      *pb.MetricResponse
+	StatSummaryResponseToReturn *pb.StatSummaryResponse
+	SelfCheckResponseToReturn   *healthcheckPb.SelfCheckResponse
+	Api_TapClientToReturn       pb.Api_TapClient
 }
 
 func (c *MockConduitApiClient) Stat(ctx context.Context, in *pb.MetricRequest, opts ...grpc.CallOption) (*pb.MetricResponse, error) {
 	return c.MetricResponseToReturn, c.ErrorToReturn
 }
 
+func (c *MockConduitApiClient) StatSummary(ctx context.Context, in *pb.StatSummaryRequest, opts ...grpc.CallOption) (*pb.StatSummaryResponse, error) {
+	return c.StatSummaryResponseToReturn, c.ErrorToReturn
+}
+
 func (c *MockConduitApiClient) Version(ctx context.Context, in *pb.Empty, opts ...grpc.CallOption) (*pb.VersionInfo, error) {
 	return c.VersionInfoToReturn, c.ErrorToReturn
 }