Introduce client csi metrics

- adds new fields to existing RPC message - these fields are updated in status of corresponding storageconsumer CRs - the status will be helpful for exporting new metrics Signed-off-by: Leela Venkaiah G <[email protected]>
red-hat-storage · Oct 6, 2023 · 54dd712 · 54dd712
1 parent d290a42
commit 54dd712
Show file tree

Hide file tree

Showing 13 changed files with 248 additions and 84 deletions.
diff --git a/api/v1alpha1/storageconsumer_types.go b/api/v1alpha1/storageconsumer_types.go
@@ -54,6 +54,14 @@ type CephResourcesSpec struct {
 	CephClients map[string]string `json:"cephClients,omitempty"`
 }
 
+// ClientInfo is the information pushed from connected storage client
+type ClientInfo struct {
+	// StorageClient Cluster Version
+	ClusterVersion string `json:"clusterVersion,omitempty"`
+	// StorageClient Operator Version
+	OperatorVersion string `json:"operatorVersion,omitempty"`
+}
+
 // StorageConsumerStatus defines the observed state of StorageConsumer
 type StorageConsumerStatus struct {
 	// State describes the state of StorageConsumer
@@ -62,6 +70,8 @@ type StorageConsumerStatus struct {
 	CephResources []*CephResourcesSpec `json:"cephResources,omitempty"`
 	// Timestamp of last heartbeat received from consumer
 	LastHeartbeat metav1.Time `json:"lastHeartbeat,omitempty"`
+	// Information of storage client received from consumer
+	Info ClientInfo `json:"info,omitempty"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/ocs.openshift.io_storageconsumers.yaml b/config/crd/bases/ocs.openshift.io_storageconsumers.yaml
@@ -66,6 +66,16 @@ spec:
                       type: string
                   type: object
                 type: array
+              info:
+                description: Information of storage client received from consumer
+                properties:
+                  clusterVersion:
+                    description: StorageClient Cluster Version
+                    type: string
+                  operatorVersion:
+                    description: StorageClient Operator Version
+                    type: string
+                type: object
               lastHeartbeat:
                 description: Timestamp of last heartbeat received from consumer
                 format: date-time

diff --git a/deploy/csv-templates/crds/ocs/ocs.openshift.io_storageconsumers.yaml b/deploy/csv-templates/crds/ocs/ocs.openshift.io_storageconsumers.yaml
@@ -66,6 +66,16 @@ spec:
                       type: string
                   type: object
                 type: array
+              info:
+                description: Information of storage client received from consumer
+                properties:
+                  clusterVersion:
+                    description: StorageClient Cluster Version
+                    type: string
+                  operatorVersion:
+                    description: StorageClient Operator Version
+                    type: string
+                type: object
               lastHeartbeat:
                 description: Timestamp of last heartbeat received from consumer
                 format: date-time

diff --git a/deploy/ocs-operator/manifests/storageconsumer.crd.yaml b/deploy/ocs-operator/manifests/storageconsumer.crd.yaml
@@ -65,6 +65,16 @@ spec:
                       type: string
                   type: object
                 type: array
+              info:
+                description: Information of storage client received from consumer
+                properties:
+                  clusterVersion:
+                    description: StorageClient Cluster Version
+                    type: string
+                  operatorVersion:
+                    description: StorageClient Operator Version
+                    type: string
+                type: object
               lastHeartbeat:
                 description: Timestamp of last heartbeat received from consumer
                 format: date-time

diff --git a/services/provider/client/client.go b/services/provider/client/client.go
@@ -7,6 +7,7 @@ import (
 	"time"
 
 	pb "github.com/red-hat-storage/ocs-operator/v4/services/provider/pb"
+	"github.com/red-hat-storage/ocs-operator/v4/services/provider/status"
 
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials"
@@ -188,12 +189,23 @@ func (cc *OCSProviderClient) GetStorageClassClaimConfig(ctx context.Context, con
 	return cc.Client.GetStorageClassClaimConfig(apiCtx, req)
 }
 
-func (cc *OCSProviderClient) ReportStatus(ctx context.Context, consumerUUID string) (*pb.ReportStatusResponse, error) {
+func (cc *OCSProviderClient) ReportStatus(ctx context.Context, consumerUUID string, fields ...status.Field) (*pb.ReportStatusResponse, error) {
 	if cc.Client == nil || cc.clientConn == nil {
 		return nil, fmt.Errorf("Provider client is closed")
 	}
+
+	var info status.Fields
+	for _, field := range fields {
+		err := field(&info)
+		if err != nil {
+			return nil, fmt.Errorf("Misformed status fields data: %v", err)
+		}
+	}
+
 	req := &pb.ReportStatusRequest{
-		StorageConsumerUUID: consumerUUID,
+		StorageConsumerUUID:   consumerUUID,
+		ClientClusterVersion:  info.ClusterVersion,
+		ClientOperatorVersion: info.OperatorVersion,
 	}
 	apiCtx, cancel := context.WithTimeout(ctx, cc.timeout)
 	defer cancel()

diff --git a/services/provider/pb/provider.pb.go b/services/provider/pb/provider.pb.go
diff --git a/services/provider/proto/provider.proto b/services/provider/proto/provider.proto
@@ -155,6 +155,8 @@ message StorageClassClaimConfigResponse{
 
 message ReportStatusRequest{
     string storageConsumerUUID = 1;
+    string clientClusterVersion = 2;
+    string clientOperatorVersion = 3;
 }
 
 message ReportStatusResponse{}