Add test for client metrics

crosbymichael · crosbymichael · commit 8510512e7e25 · 2017-09-05T17:26:26.000-04:00
Signed-off-by: Michael Crosby &lt;crosbymichael@gmail.com&gt;
diff --git a/api/next.pb.txt b/api/next.pb.txt
@@ -2926,9 +2926,16 @@ file {
       json_name: "timestamp"
     }
     field {
-      name: "data"
+      name: "id"
       number: 2
       label: LABEL_OPTIONAL
+      type: TYPE_STRING
+      json_name: "id"
+    }
+    field {
+      name: "data"
+      number: 3
+      label: LABEL_OPTIONAL
       type: TYPE_MESSAGE
       type_name: ".google.protobuf.Any"
       json_name: "data"
diff --git a/api/types/metrics.pb.go b/api/types/metrics.pb.go
diff --git a/api/types/metrics.proto b/api/types/metrics.proto
@@ -18,5 +18,6 @@ message MetricsResponse {
 
 message Metric {
 	google.protobuf.Timestamp timestamp = 1 [(gogoproto.stdtime) = true, (gogoproto.nullable) = false];
-	google.protobuf.Any data = 2;
+	string id = 2;
+	google.protobuf.Any data = 3;
 }
diff --git a/container_test.go b/container_test.go
@@ -1307,3 +1307,61 @@ func TestDeleteContainerExecCreated(t *testing.T) {
 	}
 	<-finished
 }
+
+func TestContainerMetrics(t *testing.T) {
+	t.Parallel()
+
+	client, err := newClient(t, address)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer client.Close()
+
+	var (
+		image       Image
+		ctx, cancel = testContext()
+		id          = t.Name()
+	)
+	defer cancel()
+
+	if runtime.GOOS != "windows" {
+		image, err = client.GetImage(ctx, testImage)
+		if err != nil {
+			t.Error(err)
+			return
+		}
+	}
+	container, err := client.NewContainer(ctx, id, WithNewSpec(withImageConfig(image), WithProcessArgs("sleep", "30")), withNewSnapshot(id, image))
+	if err != nil {
+		t.Error(err)
+		return
+	}
+	defer container.Delete(ctx, WithSnapshotCleanup)
+
+	task, err := container.NewTask(ctx, empty())
+	if err != nil {
+		t.Error(err)
+		return
+	}
+	defer task.Delete(ctx)
+
+	statusC, err := task.Wait(ctx)
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	metric, err := task.Metrics(ctx)
+	if err != nil {
+		t.Error(err)
+	}
+	if metric.ID != id {
+		t.Errorf("expected metric id %q but received %q", id, metric.ID)
+	}
+	if err := task.Kill(ctx, syscall.SIGKILL); err != nil {
+		t.Error(err)
+		return
+	}
+
+	<-statusC
+}
diff --git a/services/tasks/service.go b/services/tasks/service.go
@@ -18,6 +18,7 @@ import (
 	"github.com/containerd/containerd/content"
 	"github.com/containerd/containerd/errdefs"
 	"github.com/containerd/containerd/events"
+	"github.com/containerd/containerd/filters"
 	"github.com/containerd/containerd/images"
 	"github.com/containerd/containerd/log"
 	"github.com/containerd/containerd/metadata"
@@ -457,31 +458,55 @@ func (s *Service) Update(ctx context.Context, r *api.UpdateTaskRequest) (*google
 }
 
 func (s *Service) Metrics(ctx context.Context, r *types.MetricsRequest) (*types.MetricsResponse, error) {
+	filter, err := filters.ParseAll(r.Filters...)
+	if err != nil {
+		return nil, err
+	}
 	var resp types.MetricsResponse
 	for _, r := range s.runtimes {
 		tasks, err := r.Tasks(ctx)
 		if err != nil {
 			return nil, err
 		}
-		for _, t := range tasks {
-			collected := time.Now()
-			metrics, err := t.Metrics(ctx)
-			if err != nil {
-				log.G(ctx).WithError(err).Errorf("collecting metrics for %s", t.ID())
-				continue
-			}
-			data, err := typeurl.MarshalAny(metrics)
-			if err != nil {
-				log.G(ctx).WithError(err).Errorf("marshal metrics for %s", t.ID())
-				continue
+		getTasksMetrics(ctx, filter, tasks, &resp)
+	}
+	return &resp, nil
+}
+
+func getTasksMetrics(ctx context.Context, filter filters.Filter, tasks []runtime.Task, r *types.MetricsResponse) {
+	for _, tk := range tasks {
+		if !filter.Match(filters.AdapterFunc(func(fieldpath []string) (string, bool) {
+			t := tk
+			switch fieldpath[0] {
+			case "id":
+				return t.ID(), true
+			case "namespace":
+				return t.Info().Namespace, true
+			case "runtime":
+				return t.Info().Runtime, true
 			}
-			resp.Metrics = append(resp.Metrics, &types.Metric{
-				Timestamp: collected,
-				Data:      data,
-			})
+			return "", false
+		})) {
+			continue
+		}
+
+		collected := time.Now()
+		metrics, err := tk.Metrics(ctx)
+		if err != nil {
+			log.G(ctx).WithError(err).Errorf("collecting metrics for %s", tk.ID())
+			continue
 		}
+		data, err := typeurl.MarshalAny(metrics)
+		if err != nil {
+			log.G(ctx).WithError(err).Errorf("marshal metrics for %s", tk.ID())
+			continue
+		}
+		r.Metrics = append(r.Metrics, &types.Metric{
+			ID:        tk.ID(),
+			Timestamp: collected,
+			Data:      data,
+		})
 	}
-	return &resp, nil
 }
 
 func (s *Service) writeContent(ctx context.Context, mediaType, ref string, r io.Reader) (*types.Descriptor, error) {
diff --git a/task.go b/task.go
@@ -118,6 +118,8 @@ type Task interface {
 	Update(context.Context, ...UpdateTaskOpts) error
 	// LoadProcess loads a previously created exec'd process
 	LoadProcess(context.Context, string, IOAttach) (Process, error)
+	// Metrics returns task metrics for runtime specific metrics
+	Metrics(context.Context) (*types.Metric, error)
 }
 
 var _ = (Task)(&task{})
@@ -472,6 +474,18 @@ func (t *task) LoadProcess(ctx context.Context, id string, ioAttach IOAttach) (P
 	}, nil
 }
 
+func (t *task) Metrics(ctx context.Context) (*types.Metric, error) {
+	response, err := t.client.TaskService().Metrics(ctx, &types.MetricsRequest{
+		Filters: []string{
+			"id==" + t.id,
+		},
+	})
+	if err != nil {
+		return nil, errdefs.FromGRPC(err)
+	}
+	return response.Metrics[0], nil
+}
+
 func (t *task) checkpointTask(ctx context.Context, index *v1.Index, request *tasks.CheckpointTaskRequest) error {
 	response, err := t.client.TaskService().Checkpoint(ctx, request)
 	if err != nil {

Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,6 @@ message MetricsResponse {`
`18`	`18`
`19`	`19`	`message Metric {`
`20`	`20`	`google.protobuf.Timestamp timestamp = 1 [(gogoproto.stdtime) = true, (gogoproto.nullable) = false];`
`21`		`- google.protobuf.Any data = 2;`
	`21`	`+ string id = 2;`
	`22`	`+ google.protobuf.Any data = 3;`
`22`	`23`	`}`