Skip to content

Commit 6563ca2

Browse files
LionelJouinLionelJouin
committed
Add Profiling option
- Profilier disabled by default - Exposed on port 9995 by default except in fe where 9996 is used (to avoid port conflict with load-balancer) - Exposed via http (no TLS) - Remove logrus from NSP and IPAM (no usage of NSM in these containers)
1 parent 16f8aea commit 6563ca2

File tree

26 files changed

+205
-7
lines changed

26 files changed

+205
-7
lines changed

‎cmd/frontend/internal/env/config.go

+3
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,7 @@ type Config struct {
3939
AttractorName string `default:"default" desc:"Name of the Attractor the frontend is associated with" split_words:"true"`
4040
LogLevel string `default:"DEBUG" desc:"Log level" split_words:"true"`
4141
NSPEntryTimeout time.Duration `default:"30s" desc:"Timeout of the entries" envconfig:"nsp_entry_timeout"`
42+
43+
ProfilingEnabled bool `default:"false" desc:"enable profiling" split_words:"true"`
44+
ProfilingPort int `default:"9996" desc:"port of the profiling http server" split_words:"true"`
4245
}

‎cmd/frontend/main.go

+13
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"flag"
2222
"fmt"
2323
"io"
24+
"net/http"
2425
"os"
2526
"os/signal"
2627
"syscall"
@@ -37,6 +38,7 @@ import (
3738
"github.com/nordix/meridio/cmd/frontend/internal/frontend"
3839
"github.com/nordix/meridio/pkg/health"
3940
"github.com/nordix/meridio/pkg/health/connection"
41+
"github.com/nordix/meridio/pkg/profiling"
4042
"github.com/nordix/meridio/pkg/retry"
4143
"github.com/nordix/meridio/pkg/security/credentials"
4244
)
@@ -97,6 +99,17 @@ func main() {
9799
)
98100
defer cancel()
99101

102+
if config.ProfilingEnabled {
103+
go func() {
104+
mux := http.NewServeMux()
105+
profiling.AddProfilerHandlers(mux)
106+
err := http.ListenAndServe(fmt.Sprintf(":%d", config.ProfilingPort), mux)
107+
if err != nil {
108+
logrus.Errorf("err starting profiling: %v", err)
109+
}
110+
}()
111+
}
112+
100113
// create and start health server
101114
ctx = health.CreateChecker(ctx)
102115
if err := health.RegisterReadinesSubservices(ctx, health.FEReadinessServices...); err != nil {

‎cmd/ipam/config.go

+3
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,7 @@ type Config struct {
3030
NodePrefixLengthIPv6 int `default:"64" desc:"node prefix length which will be allocated" envconfig:"node_prefix_length_ipv6"`
3131
IPFamily string `default:"dualstack" desc:"ip family" envconfig:"ip_family"`
3232
LogLevel string `default:"DEBUG" desc:"Log level" split_words:"true"`
33+
34+
ProfilingEnabled bool `default:"false" desc:"enable profiling" split_words:"true"`
35+
ProfilingPort int `default:"9995" desc:"port of the profiling http server" split_words:"true"`
3336
}

‎cmd/ipam/main.go

+13-3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"flag"
2222
"fmt"
2323
"net"
24+
"net/http"
2425
"os"
2526
"os/signal"
2627
"strings"
@@ -36,8 +37,8 @@ import (
3637
"github.com/nordix/meridio/pkg/ipam"
3738
"github.com/nordix/meridio/pkg/ipam/types"
3839
"github.com/nordix/meridio/pkg/log"
40+
"github.com/nordix/meridio/pkg/profiling"
3941
"github.com/nordix/meridio/pkg/security/credentials"
40-
"github.com/sirupsen/logrus"
4142
"google.golang.org/grpc"
4243
grpcHealth "google.golang.org/grpc/health"
4344
"google.golang.org/grpc/health/grpc_health_v1"
@@ -83,10 +84,19 @@ func main() {
8384
)
8485
defer cancel()
8586

87+
if config.ProfilingEnabled {
88+
go func() {
89+
mux := http.NewServeMux()
90+
profiling.AddProfilerHandlers(mux)
91+
err := http.ListenAndServe(fmt.Sprintf(":%d", config.ProfilingPort), mux)
92+
if err != nil {
93+
logger.Error(err, "err starting profiling")
94+
}
95+
}()
96+
}
97+
8698
if config.LogLevel == "TRACE" {
8799
nsmlog.EnableTracing(true)
88-
// Work-around for hard-coded logrus dependency in NSM
89-
logrus.SetLevel(logrus.TraceLevel)
90100
}
91101
logger.Info("NSM trace", "enabled", nsmlog.IsTracingEnabled())
92102
ctx = nsmlog.WithLog(ctx, log.NSMLogger(logger)) // allow NSM logs

‎cmd/load-balancer/config.go

+3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ type Config struct {
3939
LogLevel string `default:"DEBUG" desc:"Log level" split_words:"true"`
4040
Nfqueue string `default:"0:3" desc:"netfilter queue(s) to be used by nfqlb" split_words:"true"`
4141
NfqueueFanout bool `default:"false" desc:"enable fanout nfqueue option" split_words:"true"`
42+
43+
ProfilingEnabled bool `default:"false" desc:"enable profiling" split_words:"true"`
44+
ProfilingPort int `default:"9995" desc:"port of the profiling http server" split_words:"true"`
4245
}
4346

4447
// IsValid checks if the configuration is valid

‎cmd/load-balancer/main.go

+13
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222
"flag"
2323
"fmt"
2424
"io"
25+
"net/http"
2526
"os"
2627
"os/signal"
2728
"sync"
@@ -53,6 +54,7 @@ import (
5354
"github.com/nordix/meridio/pkg/networking"
5455
"github.com/nordix/meridio/pkg/nsm"
5556
"github.com/nordix/meridio/pkg/nsm/interfacemonitor"
57+
"github.com/nordix/meridio/pkg/profiling"
5658
"github.com/nordix/meridio/pkg/retry"
5759
"github.com/nordix/meridio/pkg/security/credentials"
5860
"github.com/sirupsen/logrus"
@@ -108,6 +110,17 @@ func main() {
108110
log.Fatal(logger, "invalid config", "error", err)
109111
}
110112

113+
if config.ProfilingEnabled {
114+
go func() {
115+
mux := http.NewServeMux()
116+
profiling.AddProfilerHandlers(mux)
117+
err := http.ListenAndServe(fmt.Sprintf(":%d", config.ProfilingPort), mux)
118+
if err != nil {
119+
logger.Error(err, "err starting profiling")
120+
}
121+
}()
122+
}
123+
111124
if config.LogLevel == "TRACE" {
112125
nsmlog.EnableTracing(true)
113126
// Work-around for hard-coded logrus dependency in NSM

‎cmd/nsp/config.go

+3
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,7 @@ type Config struct {
2626
Datasource string `default:"/run/nsp/data/registry.db" desc:"Path and file name of the sqlite database" split_words:"true"`
2727
LogLevel string `default:"DEBUG" desc:"Log level" split_words:"true"`
2828
EntryTimeout time.Duration `default:"60s" desc:"Timeout of the entries" split_words:"true"`
29+
30+
ProfilingEnabled bool `default:"false" desc:"enable profiling" split_words:"true"`
31+
ProfilingPort int `default:"9995" desc:"port of the profiling http server" split_words:"true"`
2932
}

‎cmd/nsp/main.go

+13-3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"flag"
2222
"fmt"
2323
"net"
24+
"net/http"
2425
"os"
2526
"os/signal"
2627
"syscall"
@@ -34,12 +35,12 @@ import (
3435
"github.com/nordix/meridio/pkg/health"
3536
"github.com/nordix/meridio/pkg/log"
3637
"github.com/nordix/meridio/pkg/nsp"
38+
"github.com/nordix/meridio/pkg/profiling"
3739

3840
nsmlog "github.com/networkservicemesh/sdk/pkg/tools/log"
3941
keepAliveRegistry "github.com/nordix/meridio/pkg/nsp/registry/keepalive"
4042
sqliteRegistry "github.com/nordix/meridio/pkg/nsp/registry/sqlite"
4143
"github.com/nordix/meridio/pkg/security/credentials"
42-
"github.com/sirupsen/logrus"
4344
"google.golang.org/grpc"
4445
grpcHealth "google.golang.org/grpc/health"
4546
"google.golang.org/grpc/health/grpc_health_v1"
@@ -85,10 +86,19 @@ func main() {
8586
)
8687
defer cancel()
8788

89+
if config.ProfilingEnabled {
90+
go func() {
91+
mux := http.NewServeMux()
92+
profiling.AddProfilerHandlers(mux)
93+
err := http.ListenAndServe(fmt.Sprintf(":%d", config.ProfilingPort), mux)
94+
if err != nil {
95+
logger.Error(err, "err starting profiling")
96+
}
97+
}()
98+
}
99+
88100
if config.LogLevel == "TRACE" {
89101
nsmlog.EnableTracing(true)
90-
// Work-around for hard-coded logrus dependency in NSM
91-
logrus.SetLevel(logrus.TraceLevel)
92102
}
93103
logger.Info("NSM trace", "enabled", nsmlog.IsTracingEnabled())
94104
ctx = nsmlog.WithLog(ctx, log.NSMLogger(logger)) // allow NSM logs

‎cmd/proxy/internal/config/config.go

+3
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ type Config struct {
4242
IPFamily string `default:"dualstack" desc:"ip family" envconfig:"ip_family"`
4343
LogLevel string `default:"DEBUG" desc:"Log level" split_words:"true"`
4444
MTU int `default:"1500" desc:"Conduit MTU considered by local NSCs and NSE composing the network mesh" split_words:"true"`
45+
46+
ProfilingEnabled bool `default:"false" desc:"enable profiling" split_words:"true"`
47+
ProfilingPort int `default:"9995" desc:"port of the profiling http server" split_words:"true"`
4548
}
4649

4750
// IsValid checks if the configuration is valid

‎cmd/proxy/main.go

+13
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"flag"
2222
"fmt"
2323
"io"
24+
"net/http"
2425
"os"
2526
"os/signal"
2627
"syscall"
@@ -40,6 +41,7 @@ import (
4041
"github.com/nordix/meridio/pkg/nsm"
4142
"github.com/nordix/meridio/pkg/nsm/interfacemonitor"
4243
"github.com/nordix/meridio/pkg/nsp"
44+
"github.com/nordix/meridio/pkg/profiling"
4345
"github.com/nordix/meridio/pkg/retry"
4446

4547
"github.com/go-logr/logr"
@@ -89,6 +91,17 @@ func main() {
8991
logr.NewContext(context.Background(), logger))
9092
defer cancel()
9193

94+
if config.ProfilingEnabled {
95+
go func() {
96+
mux := http.NewServeMux()
97+
profiling.AddProfilerHandlers(mux)
98+
err := http.ListenAndServe(fmt.Sprintf(":%d", config.ProfilingPort), mux)
99+
if err != nil {
100+
logger.Error(err, "err starting profiling")
101+
}
102+
}()
103+
}
104+
92105
// allow NSM logs
93106
if config.LogLevel == "TRACE" {
94107
nsmlog.EnableTracing(true)

‎cmd/tapa/config.go

+3
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ type Config struct {
3535
MaxTokenLifetime time.Duration `default:"24h" desc:"maximum lifetime of tokens" split_words:"true"`
3636
LogLevel string `default:"DEBUG" desc:"Log level" split_words:"true"`
3737
NSPEntryTimeout time.Duration `default:"30s" desc:"Timeout of the entries" envconfig:"nsp_entry_timeout"`
38+
39+
ProfilingEnabled bool `default:"false" desc:"enable profiling" split_words:"true"`
40+
ProfilingPort int `default:"9995" desc:"port of the profiling http server" split_words:"true"`
3841
}
3942

4043
// IsValid checks if the configuration is valid

‎cmd/tapa/main.go

+13
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"flag"
2222
"fmt"
2323
"net"
24+
"net/http"
2425
"os"
2526
"os/signal"
2627
"syscall"
@@ -47,6 +48,7 @@ import (
4748
"github.com/nordix/meridio/pkg/log"
4849
"github.com/nordix/meridio/pkg/nsm"
4950
"github.com/nordix/meridio/pkg/nsm/interfacename"
51+
"github.com/nordix/meridio/pkg/profiling"
5052
"github.com/sirupsen/logrus"
5153
"google.golang.org/grpc"
5254
grpcHealth "google.golang.org/grpc/health"
@@ -93,6 +95,17 @@ func main() {
9395
defer cancel()
9496
logger.Info("Config read", "config", config)
9597

98+
if config.ProfilingEnabled {
99+
go func() {
100+
mux := http.NewServeMux()
101+
profiling.AddProfilerHandlers(mux)
102+
err := http.ListenAndServe(fmt.Sprintf(":%d", config.ProfilingPort), mux)
103+
if err != nil {
104+
logger.Error(err, "err starting profiling")
105+
}
106+
}()
107+
}
108+
96109
if config.LogLevel == "TRACE" {
97110
nsmlog.EnableTracing(true) // enable tracing in NSM
98111
logrus.SetLevel(logrus.TraceLevel)

‎deployments/helm/templates/ipam.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ spec:
5656
value: "{{ .Values.subnetPool.nodePrefixLength.ipv6 }}"
5757
- name: IPAM_IP_FAMILY
5858
value: "{{ .Values.ipFamily }}"
59+
- name: NSM_PROFILING_ENABLED
60+
value: "{{ .Values.profilingEnabled }}"
5961
securityContext:
6062
runAsNonRoot: true
6163
readOnlyRootFilesystem: true

‎deployments/helm/templates/load-balancer.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ spec:
6868
value: {{ .Values.maxTokenLifetime }}
6969
- name: NSM_LOG_LEVEL
7070
value: "DEBUG"
71+
- name: NSM_PROFILING_ENABLED
72+
value: "{{ .Values.profilingEnabled }}"
7173
volumeMounts:
7274
- name: spire-agent-socket
7375
mountPath: /run/spire/sockets
@@ -163,6 +165,8 @@ spec:
163165
value: {{ .Values.trench.name }}
164166
- name: NFE_ATTRACTOR_NAME
165167
value: "attractor-a"
168+
- name: NFE_PROFILING_ENABLED
169+
value: "{{ .Values.profilingEnabled }}"
166170
volumeMounts:
167171
- name: spire-agent-socket
168172
mountPath: /run/spire/sockets

‎deployments/helm/templates/nsp.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ spec:
4141
value: {{ template "meridio.configuration" . }}
4242
- name: NSP_DATASOURCE
4343
value: /run/nsp/data/registry.db
44+
- name: NSM_PROFILING_ENABLED
45+
value: "{{ .Values.profilingEnabled }}"
4446
securityContext:
4547
runAsNonRoot: true
4648
readOnlyRootFilesystem: true

‎deployments/helm/templates/proxy.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ spec:
7373
value: "DEBUG"
7474
- name: NSM_MTU
7575
value: "1500"
76+
- name: NSM_PROFILING_ENABLED
77+
value: "{{ .Values.profilingEnabled }}"
7678
volumeMounts:
7779
- name: spire-agent-socket
7880
mountPath: /run/spire/sockets

‎deployments/helm/values.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ pullPolicy: IfNotPresent
88
maxTokenLifetime: 10m
99
fsGroup: 3000
1010

11+
profilingEnabled: false
12+
1113
nsm:
1214
namespace: nsm
1315
registryService: nsm-registry-svc

‎docs/front-end.md

+2
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ NFE_NSP_SERVICE | string | IP (or domain) and port of the NSP Service | nsp-serv
5353
NFE_TRENCH_NAME | string | Name of the Trench the frontend is associated with | default
5454
NFE_ATTRACTOR_NAME | string | Name of the Attractor the frontend is associated with | default
5555
NFE_LOG_LEVEL | string | Log level | DEBUG
56+
NFE_PROFILING_ENABLED | bool | Enable profiling | false
57+
NFE_NFQUEUE_FANOUT | int | port of the profiling http server | 9996
5658

5759
## Command Line
5860

‎docs/ipam.md

+2
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ IPAM_CONDUIT_PREFIX_LENGTH_IPV6 | int | Conduit prefix length which will be allo
4949
IPAM_NODE_PREFIX_LENGTH_IPV6 | int | node prefix length which will be allocated | 64
5050
IPAM_IP_FAMILY | string | IP family (ipv4, ipv6, dualstack) | dualstack
5151
IPAM_LOG_LEVEL | string | Log level (TRACE, DEBUG, INFO, WARNING, ERROR, FATAL, PANIC) | DEBUG
52+
NSM_PROFILING_ENABLED | bool | Enable profiling | false
53+
NSM_NFQUEUE_FANOUT | int | port of the profiling http server | 9995
5254

5355
## Command Line
5456

‎docs/load-balancer.md

+2
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ NSM_TRENCH_NAME | string | Trench the pod is running on | default
2929
NSM_LOG_LEVEL | string | Log level | DEBUG
3030
NSM_NFQUEUE | string | netfilter queue(s) to be used by nfqlb | 0:3
3131
NSM_NFQUEUE_FANOUT | bool | enable fanout nfqueue option | false
32+
NSM_PROFILING_ENABLED | bool | Enable profiling | false
33+
NSM_NFQUEUE_FANOUT | int | port of the profiling http server | 9995
3234

3335
## Command Line
3436

‎docs/nsp.md

+2
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ NSM_PORT | string | Trench the pod is running on | 7778
4040
NSM_CONFIG_MAP_NAME | string | Name of the ConfigMap containing the configuration | meridio-configuration
4141
NSM_DATASOURCE | string | Path and file name of the sqlite database | /run/nsp/data/registry.db
4242
NSM_LOG_LEVEL | string | Log level | DEBUG
43+
NSM_PROFILING_ENABLED | bool | Enable profiling | false
44+
NSM_NFQUEUE_FANOUT | int | port of the profiling http server | 9995
4345

4446
## Command Line
4547

‎docs/proxy.md

+2
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ NSM_NSP_SERVICE_NAME | string | IP (or domain) of the NSP Service | nsp-service
3939
NSM_NSP_SERVICE_PORT | int | port of the NSP Service | 7778
4040
NSM_IP_FAMILY | string | ip family | dualstack
4141
NSM_LOG_LEVEL | string | Log level | DEBUG
42+
NSM_PROFILING_ENABLED | bool | Enable profiling | false
43+
NSM_NFQUEUE_FANOUT | int | port of the profiling http server | 9995
4244

4345
## Command Line
4446

‎docs/tapa.md

+2
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ MERIDIO_TIMEOUT | time.Duration | timeout of NSM request/close, NSP register/unr
5757
MERIDIO_DIAL_TIMEOUT | time.Duration | timeout to dial NSMgr | 5s
5858
MERIDIO_MAX_TOKEN_LIFETIME | time.Duration | maximum lifetime of tokens | 24h
5959
MERIDIO_LOG_LEVEL | string | Log level | DEBUG
60+
MERIDIO_PROFILING_ENABLED | bool | Enable profiling | false
61+
MERIDIO_NFQUEUE_FANOUT | int | port of the profiling http server | 9995
6062

6163
## Command Line
6264

0 commit comments

Comments
 (0)