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

Add configuration for turning profiling on/off

.golangci.yml

@@ -36,7 +36,7 @@ linters-settings:
   dupl:
     threshold: 150
   funlen:
-    Lines: 150
+    Lines: 170
     Statements: 50
   goconst:
     min-len: 2

README.md

@@ -30,6 +30,8 @@ docker build .
 * `NSM_LOG_LEVEL`               - Log level
 * `NSM_OPEN_TELEMETRY_ENDPOINT` - OpenTelemetry Collector Endpoint
 * `NSM_METRICS_EXPORT_INTERVAL` - interval between mertics exports
+* `NSM_PPROF_ENABLED`           - is pprof enabled (default: "false")
+* `NSM_PPROF_LISTEN_ON`         - pprof URL to ListenAndServe (default: "localhost:6060")
 
 # Testing
 

internal/config/config.go

@@ -1,6 +1,6 @@
 // Copyright (c) 2021-2022 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.
 //
@@ -40,4 +40,6 @@ 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"`
 }

internal/imports/imports_linux.go

@@ -30,6 +30,7 @@ import (
 	_ "github.com/networkservicemesh/sdk/pkg/tools/log/logruslogger"
 	_ "github.com/networkservicemesh/sdk/pkg/tools/nsurl"
 	_ "github.com/networkservicemesh/sdk/pkg/tools/opentelemetry"
+	_ "github.com/networkservicemesh/sdk/pkg/tools/pprofutils"
 	_ "github.com/networkservicemesh/sdk/pkg/tools/spiffejwt"
 	_ "github.com/networkservicemesh/sdk/pkg/tools/token"
 	_ "github.com/networkservicemesh/sdk/pkg/tools/tracing"

main.go

@@ -1,6 +1,6 @@
 // Copyright (c) 2021-2022 Doc.ai and/or its affiliates.
 //
-// Copyright (c) 2023 Cisco and/or its affiliates.
+// Copyright (c) 2023-2024 Cisco and/or its affiliates.
 //
 // SPDX-License-Identifier: Apache-2.0
 //
@@ -60,6 +60,7 @@ import (
 	"github.com/networkservicemesh/sdk/pkg/tools/log/logruslogger"
 	"github.com/networkservicemesh/sdk/pkg/tools/nsurl"
 	"github.com/networkservicemesh/sdk/pkg/tools/opentelemetry"
+	"github.com/networkservicemesh/sdk/pkg/tools/pprofutils"
 	"github.com/networkservicemesh/sdk/pkg/tools/spiffejwt"
 	"github.com/networkservicemesh/sdk/pkg/tools/token"
 	"github.com/networkservicemesh/sdk/pkg/tools/tracing"
@@ -118,6 +119,13 @@ func main() {
 		}()
 	}
 
+	// ********************************************************************************
+	// Configure pprof
+	// ********************************************************************************
+	if rootConf.PprofEnabled {
+		go pprofutils.ListenAndServe(ctx, rootConf.PprofListenOn)
+	}
+
 	// ********************************************************************************
 	// Get a x509Source
 	// ********************************************************************************