Merge pull request #231 from andyzhangx/metrics-issue

fix: metrics port and doc issue

Author: andyzhangx

Makefile

@@ -130,3 +130,7 @@ build-push: blob-container
 clean:
 	go clean -r -x
 	-rm -rf _output
+
+.PHONY: create-metrics-svc
+create-metrics-svc:
+	kubectl create -f deploy/example/metrics/csi-blob-controller-svc.yaml

charts/README.md

@@ -64,6 +64,9 @@ The following table lists the configurable parameters of the latest Azure Blob S
 | `serviceAccount.create`                           | whether create service account of csi-blob-controller  | true                                                              |
 | `rbac.create`                                     | whether create rbac of csi-blob-controller             | true                                                              |
 | `controller.replicas`                             | the replicas of csi-blob-controller                    | 2                                                                 |
+| `controller.metricsPort`                          | metrics port of csi-blob-controller                    | 29634                                                                 |
+| `node.metricsPort`                                | metrics port of csi-blob-node                          | 29635                                                                |
+
 ## Troubleshooting
 
 If there are some errors when using helm to install, follow the steps to debug:

charts/latest/blob-csi-driver/templates/csi-blob-controller.yaml

@@ -90,11 +90,12 @@ spec:
           args:
             - "--v=5"
             - "--endpoint=$(CSI_ENDPOINT)"
+            - "--metrics-address=0.0.0.0:{{ .Values.controller.metricsPort }}"
           ports:
             - containerPort: 29632
               name: healthz
               protocol: TCP
-            - containerPort: 29634
+            - containerPort: {{ .Values.controller.metricsPort }}
               name: metrics
               protocol: TCP
           livenessProbe:

charts/latest/blob-csi-driver/values.yaml

@@ -27,7 +27,8 @@ rbac:
   create: true
 
 controller:
+  metricsPort: 29634
   replicas: 2
 
 node:
-  metricsPort: 29625
+  metricsPort: 29635

deploy/csi-blob-controller.yaml

@@ -87,6 +87,7 @@ spec:
           args:
             - "--v=5"
             - "--endpoint=$(CSI_ENDPOINT)"
+            - "--metrics-address=0.0.0.0:29634"
           ports:
             - containerPort: 29632
               name: healthz

deploy/example/metrics/README.md

@@ -9,10 +9,11 @@ kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/blob-csi-driv
 ```console
 $ kubectl get svc csi-blob-controller -n kube-system
 NAME                  TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)     AGE
-csi-blob-controller   ClusterIP   10.0.156.8   <none>        29634/TCP   32m
+csi-blob-controller   ClusterIP   10.0.156.8   20.39.0.113   29634/TCP   32m
 ```
 
 3. Run following command to get cloudprovider_azure metrics
 ```console
-curl http://{CLUSTER-IP}:29634/metrics | grep cloudprovider_azure
-```
+ip=`kubectl get svc csi-blob-controller -n kube-system | grep blob | awk '{print $4}'`
+curl http://$ip:29634/metrics | grep cloudprovider_azure | grep -e sum -e count
+```

deploy/example/metrics/csi-blob-controller-svc.yaml

@@ -10,4 +10,4 @@ spec:
   ports:
     - port: 29634
       targetPort: 29634
-  type: ClusterIP
+  type: LoadBalancer

pkg/blobplugin/main.go

@@ -39,7 +39,7 @@ var (
 	endpoint       = flag.String("endpoint", "unix://tmp/csi.sock", "CSI endpoint")
 	nodeID         = flag.String("nodeid", "", "node id")
 	version        = flag.Bool("version", false, "Print the version and exit.")
-	metricsAddress = flag.String("metrics-address", "0.0.0.0:29624", "export the metrics")
+	metricsAddress = flag.String("metrics-address", "0.0.0.0:29634", "export the metrics")
 	kubeconfig     = flag.String("kubeconfig", "", "Absolute path to the kubeconfig file. Required only when running out of cluster.")
 )
 

test/e2e/suite_test.go

@@ -88,11 +88,17 @@ var _ = ginkgo.BeforeSuite(func() {
 		e2eBootstrap := testCmd{
 			command:  "make",
 			args:     []string{"e2e-bootstrap"},
-			startLog: "Installing Azure Blob Storage CSI driver...",
+			startLog: "Installing Azure Blob Storage CSI driver ...",
 			endLog:   "Azure Blob Storage CSI driver installed",
 		}
-		execTestCmd([]testCmd{e2eBootstrap})
 
+		createMetricsSVC := testCmd{
+			command:  "make",
+			args:     []string{"create-metrics-svc"},
+			startLog: "create metrics service ...",
+			endLog:   "metrics service created",
+		}
+		execTestCmd([]testCmd{e2eBootstrap, createMetricsSVC})
 	}
 	nodeid := os.Getenv("nodeid")
 	kubeconfig := os.Getenv(kubeconfigEnvVar)

test/utils/blob_log.sh

@@ -40,3 +40,8 @@ LABEL='app=csi-blob-node'
 kubectl get pods -n${NS} -l${LABEL} \
     | awk 'NR>1 {print $1}' \
     | xargs -I {} kubectl logs {} --prefix -c${CONTAINER} -n${NS}
+
+echo "print out cloudprovider_azure metrics ..."
+echo "======================================================================================"
+ip=`kubectl get svc csi-blob-controller -n kube-system | grep blob | awk '{print $4}'`
+curl http://$ip:29634/metrics