Allow enabling profiler port in FLP (#167)

* Allow enabling profiler port in FLP * Allow enabling profiler port in FLP * fixed container port protocol * updated flowcollector doc
netobserv · Sep 21, 2022 · b04cdad · b04cdad
1 parent 4e7d9bd
commit b04cdad
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 0 deletions.
diff --git a/api/v1alpha1/flowcollector_types.go b/api/v1alpha1/flowcollector_types.go
@@ -295,6 +295,12 @@ type FlowCollectorFLP struct {
 	// healthPort is a collector HTTP port in the Pod that exposes the health check API
 	HealthPort int32 `json:"healthPort,omitempty"`
 
+	//+kubebuilder:validation:Minimum=0
+	//+kubebuilder:validation:Maximum=65535
+	//+optional
+	// profilePort allows setting up a Go pprof profiler listening to this port
+	ProfilePort int32 `json:"profilePort,omitempty"`
+
 	//+kubebuilder:default:="quay.io/netobserv/flowlogs-pipeline:main"
 	// image of the collector container (including domain and tag)
 	Image string `json:"image,omitempty"`

diff --git a/config/crd/bases/flows.netobserv.io_flowcollectors.yaml b/config/crd/bases/flows.netobserv.io_flowcollectors.yaml
@@ -1714,6 +1714,13 @@ spec:
                     maximum: 65535
                     minimum: 1025
                     type: integer
+                  profilePort:
+                    description: profilePort allows setting up a Go pprof profiler
+                      listening to this port
+                    format: int32
+                    maximum: 65535
+                    minimum: 0
+                    type: integer
                   prometheus:
                     description: Prometheus endpoint configuration
                     properties:

diff --git a/config/samples/flows_v1alpha1_flowcollector.yaml b/config/samples/flows_v1alpha1_flowcollector.yaml
@@ -36,6 +36,7 @@ spec:
     logLevel: info
     enableKubeProbes: true
     healthPort: 8080
+    profilePort: 6060
     prometheus:
       port: 9102
     ignoreMetrics: []

diff --git a/controllers/flowlogspipeline/flp_objects.go b/controllers/flowlogspipeline/flp_objects.go
@@ -38,6 +38,7 @@ const (
 	promCerts               = "prom-certs"
 	healthServiceName       = "health"
 	prometheusServiceName   = "prometheus"
+	profilePortName         = "pprof"
 	healthTimeoutSeconds    = 5
 	livenessPeriodSeconds   = 10
 	startupFailureThreshold = 5
@@ -175,6 +176,14 @@ func (b *builder) podTemplate(hostNetwork bool, configDigest string) corev1.PodT
 		ContainerPort: b.desired.Prometheus.Port,
 	})
 
+	if b.desired.ProfilePort > 0 {
+		ports = append(ports, corev1.ContainerPort{
+			Name:          profilePortName,
+			ContainerPort: b.desired.ProfilePort,
+			Protocol:      corev1.ProtocolTCP,
+		})
+	}
+
 	volumeMounts := []corev1.VolumeMount{{
 		MountPath: configPath,
 		Name:      configVolume,
@@ -483,6 +492,11 @@ func (b *builder) configMap() (*corev1.ConfigMap, string, error) {
 		"pipeline":   stages,
 		"parameters": parameters,
 	}
+	if b.desired.ProfilePort > 0 {
+		config["profile"] = map[string]interface{}{
+			"port": b.desired.ProfilePort,
+		}
+	}
 
 	bs, err := json.Marshal(config)
 	if err != nil {

diff --git a/docs/FlowCollector.md b/docs/FlowCollector.md
@@ -2167,6 +2167,17 @@ processor defines the settings of the component that receives the flows from the
             <i>Maximum</i>: 65535<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>profilePort</b></td>
+        <td>integer</td>
+        <td>
+          profilePort allows setting up a Go pprof profiler listening to this port<br/>
+          <br/>
+            <i>Format</i>: int32<br/>
+            <i>Minimum</i>: 0<br/>
+            <i>Maximum</i>: 65535<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b><a href="#flowcollectorspecprocessorprometheus">prometheus</a></b></td>
         <td>object</td>