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

Add configuration for turning profiling on/off

README.md

@@ -16,3 +16,5 @@ Prefix service is designed to collect the local IP address ranges. Additionally,
 * `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")

internal/prefixcollector/config.go

@@ -1,6 +1,6 @@
 // Copyright (c) 2020-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.
 //
@@ -47,6 +47,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"`
 }
 
 // Validate - validates config. Checks PrefixesOutputType and every CIDR from config.ExcludedPrefixes.

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
 //
@@ -36,6 +36,7 @@ import (
 	"github.com/networkservicemesh/sdk/pkg/tools/log"
 	"github.com/networkservicemesh/sdk/pkg/tools/log/logruslogger"
 	"github.com/networkservicemesh/sdk/pkg/tools/opentelemetry"
+	"github.com/networkservicemesh/sdk/pkg/tools/pprofutils"
 )
 
 const (
@@ -88,6 +89,11 @@ func main() {
 		}()
 	}
 
+	// Configure pprof
+	if config.PprofEnabled {
+		go pprofutils.ListenAndServe(ctx, config.PprofListenOn)
+	}
+
 	log.FromContext(ctx).Info("Building Kubernetes clientSet...")
 	clientSetConfig, err := k8s.NewClientSetConfig()
 	if err != nil {

pkg/imports/imports.go

@@ -12,6 +12,7 @@ import (
 	_ "github.com/networkservicemesh/sdk/pkg/tools/log"
 	_ "github.com/networkservicemesh/sdk/pkg/tools/log/logruslogger"
 	_ "github.com/networkservicemesh/sdk/pkg/tools/opentelemetry"
+	_ "github.com/networkservicemesh/sdk/pkg/tools/pprofutils"
 	_ "github.com/networkservicemesh/sdk/pkg/tools/prefixpool"
 	_ "github.com/onsi/gomega"
 	_ "github.com/pkg/errors"