Merge pull request #526 from Ex4amp1e/add-pprof-enable-conf

Add configuration for turning profiling on/off

.golangci.yml

@@ -36,8 +36,8 @@ linters-settings:
   dupl:
     threshold: 150
   funlen:
-    Lines: 200
-    Statements: 75
+    Lines: 220
+    Statements: 80
   goconst:
     min-len: 2
     min-occurrences: 2

README.md

@@ -32,6 +32,8 @@ docker build .
 * `NSM_LOG_LEVEL`                - Log level (default: "INFO")
 * `NSM_OPEN_TELEMETRY_ENDPOINT`  - OpenTelemetry Collector Endpoint (default: "otel-collector.observability.svc.cluster.local:4317")
 * `NSM_METRICS_EXPORT_INTERVAL`  - interval between mertics exports (default: "10s")
+* `NSM_PPROF_ENABLED`            - is pprof enabled (default: "false")
+* `NSM_PPROF_LISTEN_ON`          - pprof URL to ListenAndServe (default: "localhost:6060")
 
 # Testing
 

main.go

@@ -1,6 +1,6 @@
 // Copyright (c) 2021-2023 Doc.ai and/or its affiliates.
 //
-// Copyright (c) 2023 Cisco and/or its affiliates.
+// Copyright (c) 2023-2024 Cisco and/or its affiliates.
 //
 // Copyright (c) 2024 OpenInfra Foundation Europe. All rights reserved.
 //
@@ -79,6 +79,7 @@ import (
 	"github.com/networkservicemesh/sdk/pkg/tools/grpcutils"
 	"github.com/networkservicemesh/sdk/pkg/tools/log"
 	"github.com/networkservicemesh/sdk/pkg/tools/log/logruslogger"
+	"github.com/networkservicemesh/sdk/pkg/tools/pprofutils"
 	"github.com/networkservicemesh/sdk/pkg/tools/spiffejwt"
 	"github.com/networkservicemesh/sdk/pkg/tools/tracing"
 )
@@ -97,6 +98,8 @@ type Config struct {
 	LogLevel               string              `default:"INFO" desc:"Log level" split_words:"true"`
 	OpenTelemetryEndpoint  string              `default:"otel-collector.observability.svc.cluster.local:4317" desc:"OpenTelemetry Collector Endpoint" split_words:"true"`
 	MetricsExportInterval  time.Duration       `default:"10s" desc:"interval between mertics exports" split_words:"true"`
+	PprofEnabled           bool                `default:"false" desc:"is pprof enabled" split_words:"true"`
+	PprofListenOn          string              `default:"localhost:6060" desc:"pprof URL to ListenAndServe" split_words:"true"`
 }
 
 // Process prints and processes env to config
@@ -171,6 +174,13 @@ func main() {
 		}()
 	}
 
+	// ********************************************************************************
+	// Configure pprof
+	// ********************************************************************************
+	if config.PprofEnabled {
+		go pprofutils.ListenAndServe(ctx, config.PprofListenOn)
+	}
+
 	// ********************************************************************************
 	log.FromContext(ctx).Infof("executing phase 2: retrieving svid, check spire agent logs if this is the last line you see")
 	// ********************************************************************************