Make config path optional and make metrics optional in OTel collector

dhurley · dhurley · commit 975cdd347e6b · 2025-01-24T14:34:02.000Z
diff --git a/api/grpc/mpi/v1/command.pb.go b/api/grpc/mpi/v1/command.pb.go
diff --git a/api/grpc/mpi/v1/command.pb.validate.go b/api/grpc/mpi/v1/command.pb.validate.go
diff --git a/api/grpc/mpi/v1/command.proto b/api/grpc/mpi/v1/command.proto
@@ -277,7 +277,7 @@ message InstanceRuntime {
     // the binary path location
     string binary_path = 2 [(buf.validate.field).string.prefix = "/"];
     // the config path location
-    string config_path = 3 [(buf.validate.field).string.prefix = "/"];
+    optional string config_path = 3 [(buf.validate.field).string.prefix = "/"];
     // more detailed runtime objects
     oneof details {
         // NGINX runtime configuration settings like stub_status, usually read from the NGINX config or NGINX process
diff --git a/docs/proto/protos.md b/docs/proto/protos.md
@@ -927,7 +927,7 @@ Meta-information relating to the reported instance
 | ----- | ---- | ----- | ----------- |
 | process_id | [int32](#int32) |  | the process identifier |
 | binary_path | [string](#string) |  | the binary path location |
-| config_path | [string](#string) |  | the config path location |
+| config_path | [string](#string) | optional | the config path location |
 | nginx_runtime_info | [NGINXRuntimeInfo](#mpi-v1-NGINXRuntimeInfo) |  | NGINX runtime configuration settings like stub_status, usually read from the NGINX config or NGINX process |
 | nginx_plus_runtime_info | [NGINXPlusRuntimeInfo](#mpi-v1-NGINXPlusRuntimeInfo) |  | NGINX Plus runtime configuration settings like api value, usually read from the NGINX config, NGINX process or NGINX Plus API |
 | nginx_app_protect_runtime_info | [NGINXAppProtectRuntimeInfo](#mpi-v1-NGINXAppProtectRuntimeInfo) |  | NGINX App Protect runtime information |
diff --git a/internal/collector/otelcol.tmpl b/internal/collector/otelcol.tmpl
@@ -214,6 +214,7 @@ service:
     {{- end}}
   {{- end}}
   pipelines:
+    {{- if or (ne .Receivers.HostMetrics nil) (gt (len .Receivers.OtlpReceivers) 0) (gt (len .Receivers.NginxReceivers) 0) (gt (len .Receivers.NginxPlusReceivers) 0) }}
     metrics:
       receivers:
         {{- if ne .Receivers.HostMetrics nil }}
@@ -252,6 +253,7 @@ service:
         {{- if ne .Exporters.Debug nil }}
         - debug
         {{- end  }}
+    {{- end  }}
     {{- if ne .Receivers.TcplogReceivers nil }}
     logs:
       receivers:
diff --git a/internal/resource/resource_plugin_test.go b/internal/resource/resource_plugin_test.go
@@ -37,13 +37,15 @@ import (
 func TestResource_Process(t *testing.T) {
 	ctx := context.Background()
 
+	configPath := protos.GetNginxOssInstance([]string{}).GetInstanceRuntime().GetConfigPath()
+
 	updatedInstance := &mpi.Instance{
 		InstanceConfig: protos.GetNginxOssInstance([]string{}).GetInstanceConfig(),
 		InstanceMeta:   protos.GetNginxOssInstance([]string{}).GetInstanceMeta(),
 		InstanceRuntime: &mpi.InstanceRuntime{
 			ProcessId:  56789,
 			BinaryPath: protos.GetNginxOssInstance([]string{}).GetInstanceRuntime().GetBinaryPath(),
-			ConfigPath: protos.GetNginxOssInstance([]string{}).GetInstanceRuntime().GetConfigPath(),
+			ConfigPath: &configPath,
 			Details:    protos.GetNginxOssInstance([]string{}).GetInstanceRuntime().GetDetails(),
 		},
 	}
diff --git a/internal/resource/resource_service_test.go b/internal/resource/resource_service_test.go
@@ -68,14 +68,15 @@ func TestResourceService_AddInstance(t *testing.T) {
 
 func TestResourceService_UpdateInstance(t *testing.T) {
 	ctx := context.Background()
+	configPath := protos.GetNginxOssInstance([]string{}).GetInstanceRuntime().GetConfigPath()
 
 	updatedInstance := &v1.Instance{
 		InstanceConfig: protos.GetNginxOssInstance([]string{}).GetInstanceConfig(),
 		InstanceMeta:   protos.GetNginxOssInstance([]string{}).GetInstanceMeta(),
 		InstanceRuntime: &v1.InstanceRuntime{
 			ProcessId:  56789,
 			BinaryPath: protos.GetNginxOssInstance([]string{}).GetInstanceRuntime().GetBinaryPath(),
-			ConfigPath: protos.GetNginxOssInstance([]string{}).GetInstanceRuntime().GetConfigPath(),
+			ConfigPath: &configPath,
 			Details:    protos.GetNginxOssInstance([]string{}).GetInstanceRuntime().GetDetails(),
 		},
 	}
diff --git a/internal/watcher/instance/instance_watcher_service.go b/internal/watcher/instance/instance_watcher_service.go
@@ -308,7 +308,7 @@ func (iw *InstanceWatcherService) agentInstance(ctx context.Context) *mpi.Instan
 		InstanceRuntime: &mpi.InstanceRuntime{
 			ProcessId:  iw.executer.ProcessID(),
 			BinaryPath: processPath,
-			ConfigPath: iw.agentConfig.Path,
+			ConfigPath: &iw.agentConfig.Path,
 			Details:    nil,
 		},
 	}
diff --git a/internal/watcher/instance/nginx_app_protect_process_parser.go b/internal/watcher/instance/nginx_app_protect_process_parser.go
@@ -51,6 +51,11 @@ func (n NginxAppProtectProcessParser) Parse(ctx context.Context, processes []*mo
 		if process.Name == processName {
 			instanceID := n.instanceID(process)
 
+			binaryPath := process.Exe
+			if binaryPath == "" {
+				binaryPath = strings.Split(process.Cmd, " ")[0]
+			}
+
 			instanceMap[instanceID] = &mpi.Instance{
 				InstanceMeta: &mpi.InstanceMeta{
 					InstanceId:   instanceID,
@@ -60,8 +65,7 @@ func (n NginxAppProtectProcessParser) Parse(ctx context.Context, processes []*mo
 				InstanceConfig: &mpi.InstanceConfig{},
 				InstanceRuntime: &mpi.InstanceRuntime{
 					ProcessId:  process.PID,
-					BinaryPath: process.Exe,
-					ConfigPath: "",
+					BinaryPath: binaryPath,
 					Details: &mpi.InstanceRuntime_NginxAppProtectRuntimeInfo{
 						NginxAppProtectRuntimeInfo: &mpi.NGINXAppProtectRuntimeInfo{
 							Release:                n.release(ctx),
diff --git a/internal/watcher/instance/nginx_app_protect_process_parser_test.go b/internal/watcher/instance/nginx_app_protect_process_parser_test.go
@@ -31,7 +31,6 @@ func TestNginxAppProtectProcessParser_Parse(t *testing.T) {
 		InstanceRuntime: &mpi.InstanceRuntime{
 			ProcessId:  1111,
 			BinaryPath: "/usr/share/ts/bin/bd-socket-plugin",
-			ConfigPath: "",
 			Details: &mpi.InstanceRuntime_NginxAppProtectRuntimeInfo{
 				NginxAppProtectRuntimeInfo: &mpi.NGINXAppProtectRuntimeInfo{
 					Release:                "4.11.0",
diff --git a/internal/watcher/instance/nginx_config_parser_benchmark_test.go b/internal/watcher/instance/nginx_config_parser_benchmark_test.go
@@ -54,7 +54,7 @@ func BenchmarkNginxConfigParser_Parse(b *testing.B) {
 								InstanceType: mpi.InstanceMeta_INSTANCE_TYPE_NGINX,
 							},
 							InstanceRuntime: &mpi.InstanceRuntime{
-								ConfigPath: configFilePath,
+								ConfigPath: &configFilePath,
 							},
 						},
 					)
@@ -115,7 +115,7 @@ func BenchmarkNginxConfigParserGeneratedConfig_Parse(b *testing.B) {
 							InstanceType: mpi.InstanceMeta_INSTANCE_TYPE_NGINX,
 						},
 						InstanceRuntime: &mpi.InstanceRuntime{
-							ConfigPath: location,
+							ConfigPath: &location,
 						},
 					},
 				)
diff --git a/internal/watcher/instance/nginx_config_parser_test.go b/internal/watcher/instance/nginx_config_parser_test.go
@@ -325,7 +325,8 @@ func TestNginxConfigParser_Parse(t *testing.T) {
 				FileMeta: fileMeta,
 			})
 
-			test.instance.InstanceRuntime.ConfigPath = file.Name()
+			configPath := file.Name()
+			test.instance.InstanceRuntime.ConfigPath = &configPath
 
 			agentConfig := types.AgentConfig()
 			agentConfig.AllowedDirectories = []string{dir}
diff --git a/internal/watcher/instance/nginx_process_parser.go b/internal/watcher/instance/nginx_process_parser.go
@@ -201,7 +201,7 @@ func convertInfoToInstance(nginxInfo Info) *mpi.Instance {
 		instanceRuntime = &mpi.InstanceRuntime{
 			ProcessId:  nginxInfo.ProcessID,
 			BinaryPath: nginxInfo.ExePath,
-			ConfigPath: nginxInfo.ConfPath,
+			ConfigPath: &nginxInfo.ConfPath,
 			Details: &mpi.InstanceRuntime_NginxRuntimeInfo{
 				NginxRuntimeInfo: &mpi.NGINXRuntimeInfo{
 					StubStatus: &mpi.APIDetails{
@@ -219,7 +219,7 @@ func convertInfoToInstance(nginxInfo Info) *mpi.Instance {
 		instanceRuntime = &mpi.InstanceRuntime{
 			ProcessId:  nginxInfo.ProcessID,
 			BinaryPath: nginxInfo.ExePath,
-			ConfigPath: nginxInfo.ConfPath,
+			ConfigPath: &nginxInfo.ConfPath,
 			Details: &mpi.InstanceRuntime_NginxPlusRuntimeInfo{
 				NginxPlusRuntimeInfo: &mpi.NGINXPlusRuntimeInfo{
 					StubStatus: &mpi.APIDetails{
diff --git a/test/protos/instances.go b/test/protos/instances.go
@@ -37,12 +37,14 @@ func GetAgentInstance(processID int32, agentConfig *config.Config) *mpi.Instance
 		InstanceRuntime: &mpi.InstanceRuntime{
 			ProcessId:  processID,
 			BinaryPath: "/run/nginx-agent",
-			ConfigPath: agentConfig.Path,
+			ConfigPath: &agentConfig.Path,
 		},
 	}
 }
 
 func GetNginxOssInstance(expectedModules []string) *mpi.Instance {
+	configPath := "/usr/local/etc/nginx/nginx.conf"
+
 	return &mpi.Instance{
 		InstanceMeta: &mpi.InstanceMeta{
 			InstanceId:   ossInstanceID,
@@ -52,7 +54,7 @@ func GetNginxOssInstance(expectedModules []string) *mpi.Instance {
 		InstanceRuntime: &mpi.InstanceRuntime{
 			ProcessId:  processID,
 			BinaryPath: "/usr/local/Cellar/nginx/1.25.3/bin/nginx",
-			ConfigPath: "/usr/local/etc/nginx/nginx.conf",
+			ConfigPath: &configPath,
 			Details: &mpi.InstanceRuntime_NginxRuntimeInfo{
 				NginxRuntimeInfo: &mpi.NGINXRuntimeInfo{
 					StubStatus: &mpi.APIDetails{
@@ -78,6 +80,8 @@ func GetNginxOssInstance(expectedModules []string) *mpi.Instance {
 }
 
 func GetNginxPlusInstance(expectedModules []string) *mpi.Instance {
+	configPath := "/etc/nginx/nginx.conf"
+
 	return &mpi.Instance{
 		InstanceMeta: &mpi.InstanceMeta{
 			InstanceId:   plusInstanceID,
@@ -87,7 +91,7 @@ func GetNginxPlusInstance(expectedModules []string) *mpi.Instance {
 		InstanceRuntime: &mpi.InstanceRuntime{
 			ProcessId:  processID,
 			BinaryPath: "/usr/local/Cellar/nginx/1.25.3/bin/nginx",
-			ConfigPath: "/etc/nginx/nginx.conf",
+			ConfigPath: &configPath,
 			Details: &mpi.InstanceRuntime_NginxPlusRuntimeInfo{
 				NginxPlusRuntimeInfo: &mpi.NGINXPlusRuntimeInfo{
 					StubStatus: &mpi.APIDetails{

Original file line number	Diff line number	Diff line change
`@@ -308,7 +308,7 @@ func (iw InstanceWatcherService) agentInstance(ctx context.Context) mpi.Instan`
`308`	`308`	`InstanceRuntime: &mpi.InstanceRuntime{`
`309`	`309`	`ProcessId: iw.executer.ProcessID(),`
`310`	`310`	`BinaryPath: processPath,`
`311`		`- ConfigPath: iw.agentConfig.Path,`
	`311`	`+ ConfigPath: &iw.agentConfig.Path,`
`312`	`312`	`Details: nil,`
`313`	`313`	`},`
`314`	`314`	`}`