Add configuration for turning profiling on/off.

Signed-off-by: Vitaliy Guschin <[email protected]>

Author: Vitaliy Guschin

.golangci.yml

@@ -57,6 +57,10 @@ linters-settings:
     simple: true
     range-loops: true
     for-loops: false
+  gosec:
+    excludes:
+      - G108
+      - G114
   gocritic:
     enabled-checks:
       - appendAssign

README.md

@@ -46,6 +46,8 @@ docker build .
 * `NSM_CGROUP_PATH`              - path to the host cgroup directory
 * `NSM_VFIO_PATH`                - path to the host VFIO directory
 * `NSM_MECHANISM_PRIORITY`       - sets priorities for mechanisms
+* `NSM_ENABLE_PROFILER`          - Enable pprof package HTTP server for profiling runtime data.
+* `NSM_PROFILER_HTTP_PORT`       - Profiling server HTTP port providing data in the format expected by the pprof visualization tool.
 
 # Testing
 

internal/config/config.go

@@ -64,6 +64,8 @@ type Config struct {
 	CgroupPath          string        `default:"/host/sys/fs/cgroup/devices" desc:"path to the host cgroup directory" split_words:"true"`
 	VFIOPath            string        `default:"/host/dev/vfio" desc:"path to the host VFIO directory" split_words:"true"`
 	MechanismPriority   []string      `default:"" desc:"sets priorities for mechanisms" split_words:"true"`
+	EnableProfiler      bool          `default:"false" desc:"Enable pprof package HTTP server for profiling runtime data. The handled paths all begin with /debug/pprof/." split_words:"true"`
+	ProfilerHTTPPort    uint16        `default:"6060" desc:"Profiling server HTTP port providing data in the format expected by the pprof visualization tool." split_words:"true"`
 }
 
 // Process reads config from env

internal/imports/imports_linux.go

@@ -22,6 +22,7 @@ package main
 import (
 	"context"
 	"crypto/tls"
+	"fmt"
 	"os"
 	"os/signal"
 	"path"
@@ -70,6 +71,9 @@ import (
 	"github.com/networkservicemesh/cmd-forwarder-vpp/internal/devicecfg"
 	"github.com/networkservicemesh/cmd-forwarder-vpp/internal/vppinit"
 	"github.com/networkservicemesh/cmd-forwarder-vpp/internal/xconnectns"
+
+	"net/http"
+	_ "net/http/pprof"
 )
 
 func main() {
@@ -134,6 +138,18 @@ func main() {
 	log.EnableTracing(true)
 	log.FromContext(ctx).WithField("duration", time.Since(now)).Infof("completed phase 1: get config from environment")
 
+	// Enable profiling server
+	if cfg.EnableProfiler {
+		go func() {
+			log.FromContext(ctx).Infof("Profiler is enabled. Starting HTTP server on %d", cfg.ProfilerHTTPPort)
+
+			address := fmt.Sprintf("localhost:%d", cfg.ProfilerHTTPPort)
+			if err := http.ListenAndServe(address, nil); err != nil {
+				log.FromContext(ctx).Errorf("Failed to start profiler: %s", err.Error())
+			}
+		}()
+	}
+
 	// ********************************************************************************
 	// Configure Open Telemetry
 	// ********************************************************************************