Sandbox: Add Metrics rpc for controller

dcantah · dcantah · commit d278d37caae5 · 2023-06-13T00:24:09.000-07:00
As a follow up change to adding a SandboxMetrics rpc to the core
sandbox service, the controller needed a corresponding rpc for CRI
and others to eventually implement.

This leaves the CRI (non-shim mode) controller unimplemented just to
have a change with the API addition to start.

Signed-off-by: Danny Canter &lt;danny@dcantah.dev&gt;
diff --git a/api/next.pb.txt b/api/next.pb.txt
@@ -5006,6 +5006,7 @@ file {
   dependency: "github.com/containerd/containerd/api/types/sandbox.proto"
   dependency: "github.com/containerd/containerd/api/types/mount.proto"
   dependency: "github.com/containerd/containerd/api/types/platform.proto"
+  dependency: "github.com/containerd/containerd/api/types/metrics.proto"
   message_type {
     name: "StoreCreateRequest"
     field {
@@ -5393,6 +5394,27 @@ file {
   message_type {
     name: "ControllerShutdownResponse"
   }
+  message_type {
+    name: "ControllerMetricsRequest"
+    field {
+      name: "sandbox_id"
+      number: 1
+      label: LABEL_OPTIONAL
+      type: TYPE_STRING
+      json_name: "sandboxId"
+    }
+  }
+  message_type {
+    name: "ControllerMetricsResponse"
+    field {
+      name: "metrics"
+      number: 1
+      label: LABEL_OPTIONAL
+      type: TYPE_MESSAGE
+      type_name: ".containerd.types.Metric"
+      json_name: "metrics"
+    }
+  }
   service {
     name: "Store"
     method {
@@ -5458,6 +5480,11 @@ file {
       input_type: ".containerd.services.sandbox.v1.ControllerShutdownRequest"
       output_type: ".containerd.services.sandbox.v1.ControllerShutdownResponse"
     }
+    method {
+      name: "Metrics"
+      input_type: ".containerd.services.sandbox.v1.ControllerMetricsRequest"
+      output_type: ".containerd.services.sandbox.v1.ControllerMetricsResponse"
+    }
   }
   options {
     go_package: "github.com/containerd/containerd/api/services/sandbox/v1;sandbox"
diff --git a/api/services/sandbox/v1/sandbox.pb.go b/api/services/sandbox/v1/sandbox.pb.go
diff --git a/api/services/sandbox/v1/sandbox.proto b/api/services/sandbox/v1/sandbox.proto
@@ -31,6 +31,7 @@ import "google/protobuf/timestamp.proto";
 import "github.com/containerd/containerd/api/types/sandbox.proto";
 import "github.com/containerd/containerd/api/types/mount.proto";
 import "github.com/containerd/containerd/api/types/platform.proto";
+import "github.com/containerd/containerd/api/types/metrics.proto";
 
 option go_package = "github.com/containerd/containerd/api/services/sandbox/v1;sandbox";
 
@@ -93,6 +94,7 @@ service Controller {
 	rpc Wait(ControllerWaitRequest) returns (ControllerWaitResponse);
 	rpc Status(ControllerStatusRequest) returns (ControllerStatusResponse);
 	rpc Shutdown(ControllerShutdownRequest) returns (ControllerShutdownResponse);
+	rpc Metrics(ControllerMetricsRequest) returns (ControllerMetricsResponse);
 }
 
 message ControllerCreateRequest {
@@ -161,3 +163,11 @@ message ControllerShutdownRequest {
 }
 
 message ControllerShutdownResponse {}
+
+message ControllerMetricsRequest {
+	string sandbox_id = 1;
+}
+
+message ControllerMetricsResponse {
+	types.Metric metrics = 1;
+}
diff --git a/api/services/sandbox/v1/sandbox_grpc.pb.go b/api/services/sandbox/v1/sandbox_grpc.pb.go
diff --git a/pkg/cri/sbserver/podsandbox/sandbox_stats.go b/pkg/cri/sbserver/podsandbox/sandbox_stats.go
@@ -0,0 +1,29 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package podsandbox
+
+import (
+	"context"
+
+	"github.com/containerd/containerd/api/types"
+	"github.com/containerd/containerd/errdefs"
+)
+
+// TODO(dcantah): Implement metrics to be used for SandboxStats rpc.
+func (c *Controller) Metrics(ctx context.Context, sandboxID string) (*types.Metric, error) {
+	return nil, errdefs.ErrNotImplemented
+}
diff --git a/plugins/sandbox/controller.go b/plugins/sandbox/controller.go
@@ -22,6 +22,7 @@ import (
 	"time"
 
 	runtimeAPI "github.com/containerd/containerd/api/runtime/sandbox/v1"
+	"github.com/containerd/containerd/api/types"
 	"github.com/containerd/containerd/errdefs"
 	"github.com/containerd/containerd/events"
 	"github.com/containerd/containerd/events/exchange"
@@ -283,6 +284,19 @@ func (c *controllerLocal) Status(ctx context.Context, sandboxID string, verbose
 	}, nil
 }
 
+func (c *controllerLocal) Metrics(ctx context.Context, sandboxID string) (*types.Metric, error) {
+	sb, err := c.getSandbox(ctx, sandboxID)
+	if err != nil {
+		return nil, err
+	}
+	req := &runtimeAPI.SandboxMetricsRequest{SandboxID: sandboxID}
+	resp, err := sb.SandboxMetrics(ctx, req)
+	if err != nil {
+		return nil, err
+	}
+	return resp.Metrics, nil
+}
+
 func (c *controllerLocal) getSandbox(ctx context.Context, id string) (runtimeAPI.TTRPCSandboxService, error) {
 	shim, err := c.shims.Get(ctx, id)
 	if err != nil {
diff --git a/sandbox/controller.go b/sandbox/controller.go
@@ -100,6 +100,8 @@ type Controller interface {
 	Status(ctx context.Context, sandboxID string, verbose bool) (ControllerStatus, error)
 	// Shutdown deletes and cleans all tasks and sandbox instance.
 	Shutdown(ctx context.Context, sandboxID string) error
+	// Metrics queries the sandbox for metrics.
+	Metrics(ctx context.Context, sandboxID string) (*types.Metric, error)
 }
 
 type ControllerInstance struct {
diff --git a/sandbox/proxy/controller.go b/sandbox/proxy/controller.go
@@ -20,6 +20,7 @@ import (
 	"context"
 
 	api "github.com/containerd/containerd/api/services/sandbox/v1"
+	"github.com/containerd/containerd/api/types"
 	"github.com/containerd/containerd/errdefs"
 	"github.com/containerd/containerd/platforms"
 	"github.com/containerd/containerd/sandbox"
@@ -140,3 +141,11 @@ func (s *remoteSandboxController) Status(ctx context.Context, sandboxID string,
 		Extra:     resp.GetExtra(),
 	}, nil
 }
+
+func (s *remoteSandboxController) Metrics(ctx context.Context, sandboxID string) (*types.Metric, error) {
+	resp, err := s.client.Metrics(ctx, &api.ControllerMetricsRequest{SandboxID: sandboxID})
+	if err != nil {
+		return nil, errdefs.FromGRPC(err)
+	}
+	return resp.Metrics, nil
+}
diff --git a/services/sandbox/controller_service.go b/services/sandbox/controller_service.go
@@ -162,3 +162,15 @@ func (s *controllerService) Shutdown(ctx context.Context, req *api.ControllerShu
 	log.G(ctx).WithField("req", req).Debug("shutdown sandbox")
 	return &api.ControllerShutdownResponse{}, errdefs.ToGRPC(s.local.Shutdown(ctx, req.GetSandboxID()))
 }
+
+func (s *controllerService) Metrics(ctx context.Context, req *api.ControllerMetricsRequest) (*api.ControllerMetricsResponse, error) {
+	log.G(ctx).WithField("req", req).Debug("sandbox metrics")
+
+	metrics, err := s.local.Metrics(ctx, req.GetSandboxID())
+	if err != nil {
+		return &api.ControllerMetricsResponse{}, errdefs.ToGRPC(err)
+	}
+	return &api.ControllerMetricsResponse{
+		Metrics: metrics,
+	}, nil
+}

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,8 @@ type Controller interface {`
`100`	`100`	`Status(ctx context.Context, sandboxID string, verbose bool) (ControllerStatus, error)`
`101`	`101`	`// Shutdown deletes and cleans all tasks and sandbox instance.`
`102`	`102`	`Shutdown(ctx context.Context, sandboxID string) error`
	`103`	`+ // Metrics queries the sandbox for metrics.`
	`104`	`+ Metrics(ctx context.Context, sandboxID string) (*types.Metric, error)`
`103`	`105`	`}`
`104`	`106`
`105`	`107`	`type ControllerInstance struct {`