fix: crane uses port/targetPort in serviceMonitors for metrics (#964)

dyrector-io · Apr 19, 2024 · 995230c · 995230c
1 parent 22614cd
commit 995230c
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 28 deletions.
diff --git a/golang/api/v1/deploy.go b/golang/api/v1/deploy.go
@@ -256,8 +256,10 @@ type ContainerConfig struct {
 }
 
 type Metrics struct {
+	// Path the path to be scraped, if not defined /metrics is used
 	Path string `json:"path"`
-	Port string `json:"port"`
+	// Port exposed port of the service where metrics are available
+	Port int `json:"port"`
 }
 
 func (c *ContainerConfig) Strings(appConfig *config.CommonConfiguration) []string {

diff --git a/golang/internal/mapper/grpc.go b/golang/internal/mapper/grpc.go
@@ -224,7 +224,7 @@ func mapCraneConfig(crane *agent.CraneContainerConfig, containerConfig *v1.Conta
 	if crane.Metrics != nil {
 		containerConfig.Metrics = &v1.Metrics{
 			Path: crane.Metrics.Path,
-			Port: crane.Metrics.Path,
+			Port: int(crane.Metrics.Port),
 		}
 	}
 }

diff --git a/golang/pkg/crane/k8s/service_monitor.go b/golang/pkg/crane/k8s/service_monitor.go
@@ -11,6 +11,7 @@ import (
 
 	smv1 "github.com/prometheus-operator/prometheus-operator/pkg/client/applyconfiguration/monitoring/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
 type ServiceMonitor struct {
@@ -58,28 +59,28 @@ func (sm *ServiceMonitor) Deploy(namespace, serviceName string, metricParams v1.
 		return err
 	}
 
-	portName := metricParams.Port
-
-	if portName == "" {
-		portName = firstPort
-	}
-
 	metricsPath := metricParams.Path
 	if metricsPath == "" {
 		metricsPath = "/metrics"
 	}
 
+	endpoint := smv1.Endpoint().WithPath(metricsPath)
+	if metricParams.Port != 0 {
+		endpoint = endpoint.WithTargetPort(intstr.FromInt(metricParams.Port))
+	} else {
+		endpoint = endpoint.WithPort(firstPort)
+	}
+
 	smApplyConfig := smv1.ServiceMonitor(serviceName, namespace).
 		WithSpec(smv1.ServiceMonitorSpec().
-			WithEndpoints(
-				smv1.Endpoint().WithPort(portName).WithPath(metricsPath),
-			).WithSelector(
-			metav1.LabelSelector{
-				MatchLabels: map[string]string{
-					"app": serviceName,
+			WithEndpoints(endpoint).
+			WithSelector(
+				metav1.LabelSelector{
+					MatchLabels: map[string]string{
+						"app": serviceName,
+					},
 				},
-			},
-		))
+			))
 
 	_, err = sm.ClientSet.MonitoringV1().ServiceMonitors(namespace).Apply(sm.Ctx, smApplyConfig, metav1.ApplyOptions{
 		FieldManager: sm.appConfig.FieldManagerName,

diff --git a/golang/pkg/crane/k8s/service_monitor_test.go b/golang/pkg/crane/k8s/service_monitor_test.go
@@ -31,7 +31,7 @@ func TestMain(m *testing.M) {
 func TestServiceMonitorSpawning(t *testing.T) {
 	m, err := k8s.NewServiceMonitor(context.Background(), k8s.NewClient(getTestConfig()))
 	assert.Nil(t, err, "client is spawned without errors")
-	err = m.Deploy("crane-sm-test", "test-sm", v1.Metrics{Path: "/metrics", Port: "tcp-metrics"}, "")
+	err = m.Deploy("crane-sm-test", "test-sm", v1.Metrics{Path: "/metrics", Port: 8080}, "")
 	assert.Nil(t, err, "no errors expected with default parameters")
 }
 

diff --git a/protobuf/go/agent/agent.pb.go b/protobuf/go/agent/agent.pb.go
diff --git a/protobuf/proto/agent.proto b/protobuf/proto/agent.proto
@@ -187,7 +187,7 @@ message Marker {
 }
 
 message Metrics {
-  string port = 1;
+  int32 port = 1;
   string path = 2;
 }
 

diff --git a/web/crux/proto/agent.proto b/web/crux/proto/agent.proto
@@ -187,7 +187,7 @@ message Marker {
 }
 
 message Metrics {
-  string port = 1;
+  int32 port = 1;
   string path = 2;
 }
 

diff --git a/web/crux/src/app/deploy/deploy.mapper.ts b/web/crux/src/app/deploy/deploy.mapper.ts
@@ -387,7 +387,7 @@ export default class DeployMapper {
       metrics: config.metrics?.enabled
         ? {
             path: config.metrics.path ?? null,
-            port: config.metrics.port?.toString() ?? null,
+            port: config.metrics.port ?? null,
           }
         : null,
     }

diff --git a/web/crux/src/grpc/protobuf/proto/agent.ts b/web/crux/src/grpc/protobuf/proto/agent.ts
@@ -267,7 +267,7 @@ export interface Marker_IngressEntry {
 }
 
 export interface Metrics {
-  port: string
+  port: number
   path: string
 }
 
@@ -1049,17 +1049,17 @@ export const Marker_IngressEntry = {
 }
 
 function createBaseMetrics(): Metrics {
-  return { port: '', path: '' }
+  return { port: 0, path: '' }
 }
 
 export const Metrics = {
   fromJSON(object: any): Metrics {
-    return { port: isSet(object.port) ? String(object.port) : '', path: isSet(object.path) ? String(object.path) : '' }
+    return { port: isSet(object.port) ? Number(object.port) : 0, path: isSet(object.path) ? String(object.path) : '' }
   },
 
   toJSON(message: Metrics): unknown {
     const obj: any = {}
-    message.port !== undefined && (obj.port = message.port)
+    message.port !== undefined && (obj.port = Math.round(message.port))
     message.path !== undefined && (obj.path = message.path)
     return obj
   },