embedded otel collector

aphralG · aphralG · commit 69b27ae08a53 · 2025-10-01T17:24:06.000+01:00
diff --git a/internal/collector/nginxossreceiver/internal/config/config.go b/internal/collector/nginxossreceiver/internal/config/config.go
@@ -24,6 +24,7 @@ const (
 type Config struct {
 	confighttp.ClientConfig        `mapstructure:",squash"`
 	APIDetails                     APIDetails                    `mapstructure:"api_details"`
+	InstanceID                     string                        `mapstructure:"instance_id"`
 	AccessLogs                     []AccessLog                   `mapstructure:"access_logs"`
 	MetricsBuilderConfig           metadata.MetricsBuilderConfig `mapstructure:",squash"`
 	scraperhelper.ControllerConfig `mapstructure:",squash"`
diff --git a/internal/collector/nginxossreceiver/internal/scraper/accesslog/nginx_log_scraper.go b/internal/collector/nginxossreceiver/internal/scraper/accesslog/nginx_log_scraper.go
@@ -171,7 +171,7 @@ func (nls *NginxLogScraper) Scrape(_ context.Context) (pmetric.Metrics, error) {
 	nls.entries = make([]*entry.Entry, 0)
 	timeNow := pcommon.NewTimestampFromTime(time.Now())
 
-	nls.rb.SetInstanceID(nls.settings.ID.Name())
+	nls.rb.SetInstanceID(nls.cfg.InstanceID)
 	nls.rb.SetInstanceType("nginx")
 	nls.logger.Debug("NGINX OSS access log resource info", zap.Any("resource", nls.rb))
 
diff --git a/internal/collector/nginxossreceiver/internal/scraper/stubstatus/stub_status_scraper.go b/internal/collector/nginxossreceiver/internal/scraper/stubstatus/stub_status_scraper.go
@@ -138,7 +138,7 @@ func (s *NginxStubStatusScraper) Scrape(context.Context) (pmetric.Metrics, error
 		return pmetric.Metrics{}, err
 	}
 
-	s.rb.SetInstanceID(s.settings.ID.Name())
+	s.rb.SetInstanceID(s.cfg.InstanceID)
 	s.rb.SetInstanceType("nginx")
 	s.settings.Logger.Debug("NGINX OSS stub status resource info", zap.Any("resource", s.rb))
 
diff --git a/internal/collector/nginxplusreceiver/config.go b/internal/collector/nginxplusreceiver/config.go
@@ -21,6 +21,7 @@ const defaultCollectInterval = 10 * time.Second
 type Config struct {
 	confighttp.ClientConfig        `mapstructure:",squash"`
 	APIDetails                     APIDetails                    `mapstructure:"api_details"`
+	InstanceID                     string                        `mapstructure:"instance_id"`
 	MetricsBuilderConfig           metadata.MetricsBuilderConfig `mapstructure:",squash"`
 	scraperhelper.ControllerConfig `mapstructure:",squash"`
 }
diff --git a/internal/collector/nginxplusreceiver/scraper.go b/internal/collector/nginxplusreceiver/scraper.go
@@ -127,7 +127,7 @@ func (nps *NginxPlusScraper) Scrape(ctx context.Context) (pmetric.Metrics, error
 		return pmetric.Metrics{}, fmt.Errorf("failed to get stats from plus API: %w", err)
 	}
 
-	nps.rb.SetInstanceID(nps.settings.ID.Name())
+	nps.rb.SetInstanceID(nps.cfg.InstanceID)
 	nps.rb.SetInstanceType("nginxplus")
 	nps.logger.Debug("NGINX Plus resource info", zap.Any("resource", nps.rb))
 
diff --git a/internal/collector/otel_collector_plugin.go b/internal/collector/otel_collector_plugin.go
@@ -16,7 +16,9 @@ import (
 	"sync"
 	"time"
 
+	"github.com/goccy/go-yaml"
 	pkgConfig "github.com/nginx/agent/v3/pkg/config"
+	"go.opentelemetry.io/collector/confmap"
 
 	"github.com/nginx/agent/v3/api/grpc/mpi/v1"
 	"github.com/nginx/agent/v3/internal/backoff"
@@ -384,6 +386,31 @@ func (oc *Collector) updateHeadersSetterExtension(
 	return headersSetterExtensionUpdated
 }
 
+func (oc *Collector) writeRunningConfig(ctx context.Context, settings otelcol.CollectorSettings) error {
+	slog.DebugContext(ctx, "Writing running OTel collector config", "path",
+		"/var/lib/nginx-agent/opentelemetry-collector-agent-debug.yaml")
+	resolver, err := confmap.NewResolver(settings.ConfigProviderSettings.ResolverSettings)
+	if err != nil {
+		return fmt.Errorf("unable to create resolver: %w", err)
+	}
+
+	con, err := resolver.Resolve(ctx)
+	if err != nil {
+		return fmt.Errorf("error while resolving config: %w", err)
+	}
+	b, err := yaml.Marshal(con.ToStringMap())
+	if err != nil {
+		return fmt.Errorf("error while marshaling to YAML: %w", err)
+	}
+
+	writeErr := os.WriteFile("/var/lib/nginx-agent/opentelemetry-collector-agent-debug.yaml", b, filePermission)
+	if writeErr != nil {
+		return fmt.Errorf("error while writing debug config: %w", err)
+	}
+
+	return nil
+}
+
 func (oc *Collector) restartCollector(ctx context.Context) {
 	err := oc.Close(ctx)
 	if err != nil {
@@ -392,6 +419,14 @@ func (oc *Collector) restartCollector(ctx context.Context) {
 	}
 
 	settings := OTelCollectorSettings(oc.config)
+
+	if strings.ToLower(oc.config.Log.Level) == "debug" {
+		writeErr := oc.writeRunningConfig(ctx, settings)
+		if writeErr != nil {
+			slog.ErrorContext(ctx, "Failed to write debug OTel Collector config", "error", writeErr)
+		}
+	}
+
 	oTelCollector, err := otelcol.NewCollector(settings)
 	if err != nil {
 		slog.ErrorContext(ctx, "Failed to create OTel Collector", "error", err)
diff --git a/internal/collector/otelcol.tmpl b/internal/collector/otelcol.tmpl
@@ -79,7 +79,12 @@ receivers:
 {{- end }}
 
 {{- range .Receivers.NginxReceivers }}
+{{- if gt (len $.Receivers.NginxReceivers) 1 }}
   nginx/{{- .InstanceID -}}:
+{{- else }}
+  nginx:
+{{- end}}
+    instance_id: "{{- .InstanceID -}}"
     api_details:
       url: "{{- .StubStatus.URL -}}"
       listen: "{{- .StubStatus.Listen -}}"
@@ -98,12 +103,17 @@ receivers:
 {{- end }}
 
 {{- range .Receivers.NginxPlusReceivers }}
+{{- if gt (len $.Receivers.NginxPlusReceivers) 1 }}
   nginxplus/{{- .InstanceID -}}:
+{{- else }}
+  nginxplus:
+{{- end}}
+    instance_id: "{{- .InstanceID -}}"
     api_details:
-        url: "{{- .PlusAPI.URL -}}"
-        listen: "{{- .PlusAPI.Listen -}}"
-        location: "{{- .PlusAPI.Location -}}"
-        ca: "{{- .PlusAPI.Ca -}}"
+      url: "{{- .PlusAPI.URL -}}"
+      listen: "{{- .PlusAPI.Listen -}}"
+      location: "{{- .PlusAPI.Location -}}"
+      ca: "{{- .PlusAPI.Ca -}}"
     {{- if .CollectionInterval }}
     collection_interval: {{ .CollectionInterval }}
     {{- end }}
@@ -274,10 +284,18 @@ service:
             {{- end }}
           {{- else if eq $receiver "nginx_metrics" }}
             {{- range $.Receivers.NginxReceivers }}
+            {{- if gt (len $.Receivers.NginxReceivers) 1 }}
         - nginx/{{- .InstanceID -}}
+            {{- else }}
+        - nginx
+            {{- end }}
             {{- end }}
             {{- range $.Receivers.NginxPlusReceivers }}
+            {{- if gt (len $.Receivers.NginxReceivers) 1 }}
         - nginxplus/{{- .InstanceID -}}
+            {{- else }}
+        - nginxplus
+            {{- end }}
             {{- end }}
           {{- else }}
         - {{ $receiver }}
diff --git a/internal/collector/settings.go b/internal/collector/settings.go
@@ -71,7 +71,11 @@ func createConverterFactories() []confmap.ConverterFactory {
 }
 
 func createURIs(cfg *config.Config) []string {
-	return []string{cfg.Collector.ConfigPath}
+	configFiles := []string{cfg.Collector.ConfigPath}
+	configFiles = slices.Concat(configFiles, cfg.Collector.AdditionalPaths)
+	slog.Info("Additional config files:", "", configFiles)
+
+	return configFiles
 }
 
 func createFile(confPath string) error {
diff --git a/internal/collector/settings_test.go b/internal/collector/settings_test.go
@@ -7,6 +7,7 @@ package collector
 import (
 	"os"
 	"path/filepath"
+	"slices"
 	"testing"
 	"time"
 
@@ -107,6 +108,28 @@ func TestTemplateWrite(t *testing.T) {
 			},
 		},
 	})
+
+	cfg.Collector.Receivers.NginxPlusReceivers = slices.Concat(cfg.Collector.Receivers.NginxPlusReceivers,
+		[]config.NginxPlusReceiver{
+			{
+				InstanceID: "456",
+				PlusAPI: config.APIDetails{
+					URL:      "http://localhost:80/api",
+					Listen:   "",
+					Location: "",
+				},
+				CollectionInterval: 20 * time.Second,
+			},
+			{
+				InstanceID: "789",
+				PlusAPI: config.APIDetails{
+					URL:      "http://localhost:90/api",
+					Listen:   "",
+					Location: "",
+				},
+				CollectionInterval: 20 * time.Second,
+			},
+		})
 	// Clear default config and test collector with TLS enabled
 	cfg.Collector.Receivers.OtlpReceivers["default"] = &config.OtlpReceiver{
 		Server: &config.ServerConfig{
@@ -165,7 +188,10 @@ func TestTemplateWrite(t *testing.T) {
 
 	cfg.Collector.Pipelines.Metrics = make(map[string]*config.Pipeline)
 	cfg.Collector.Pipelines.Metrics["default"] = &config.Pipeline{
-		Receivers:  []string{"hostmetrics", "containermetrics", "otlp/default", "nginx/123"},
+		Receivers: []string{
+			"hostmetrics", "containermetrics",
+			"otlp/default", "nginx", "nginxplus/456", "nginxplus/789",
+		},
 		Processors: []string{"resource/default", "batch/default"},
 		Exporters:  []string{"otlp/default", "prometheus", "debug"},
 	}
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -1061,14 +1061,14 @@ func resolveCollector(allowedDirs []string) (*Collector, error) {
 	}
 
 	col := &Collector{
-		ConfigPath: viperInstance.GetString(CollectorConfigPathKey),
+		ConfigPath:      viperInstance.GetString(CollectorConfigPathKey),
 		AdditionalPaths: viperInstance.GetStringSlice(CollectorAdditionalConfigPathsKey),
-		Exporters:  exporters,
-		Processors: resolveProcessors(),
-		Receivers:  receivers,
-		Extensions: resolveExtensions(),
-		Log:        resolveCollectorLog(),
-		Pipelines:  resolvePipelines(),
+		Exporters:       exporters,
+		Processors:      resolveProcessors(),
+		Receivers:       receivers,
+		Extensions:      resolveExtensions(),
+		Log:             resolveCollectorLog(),
+		Pipelines:       resolvePipelines(),
 	}
 
 	// Check for self-signed certificate true in Agent conf
diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -1111,7 +1111,7 @@ func createConfig() *Config {
 			},
 		},
 		Collector: &Collector{
-			ConfigPath: "/etc/nginx-agent/nginx-agent-otelcol.yaml",
+			ConfigPath:      "/etc/nginx-agent/nginx-agent-otelcol.yaml",
 			AdditionalPaths: []string{"/configs/my_config.yaml", "/etc/nginx-agent/nginx-agent-otelcol.yaml"},
 			Exporters: Exporters{
 				OtlpExporters: map[string]*OtlpExporter{
diff --git a/internal/config/defaults.go b/internal/config/defaults.go
@@ -85,13 +85,13 @@ const (
 	DefFileWatcherMonitoringFrequency           = 5 * time.Second
 
 	// Collector defaults
-	DefCollectorConfigPath            = "/etc/nginx-agent/opentelemetry-collector-agent.yaml"
-	DefCollectorLogLevel              = "INFO"
-	DefCollectorLogPath               = "/var/log/nginx-agent/opentelemetry-collector-agent.log"
-	DefCollectorTLSCertPath           = "/var/lib/nginx-agent/cert.pem"
-	DefCollectorTLSKeyPath            = "/var/lib/nginx-agent/key.pem"
-	DefCollectorTLSCAPath             = "/var/lib/nginx-agent/ca.pem"
-	DefCollectorTLSSANNames           = "127.0.0.1,::1,localhost"
+	DefCollectorConfigPath  = "/etc/nginx-agent/opentelemetry-collector-agent.yaml"
+	DefCollectorLogLevel    = "INFO"
+	DefCollectorLogPath     = "/var/log/nginx-agent/opentelemetry-collector-agent.log"
+	DefCollectorTLSCertPath = "/var/lib/nginx-agent/cert.pem"
+	DefCollectorTLSKeyPath  = "/var/lib/nginx-agent/key.pem"
+	DefCollectorTLSCAPath   = "/var/lib/nginx-agent/ca.pem"
+	DefCollectorTLSSANNames = "127.0.0.1,::1,localhost"
 
 	DefCollectorMetricsBatchProcessorSendBatchSize    = 1000
 	DefCollectorMetricsBatchProcessorSendBatchMaxSize = 1000
diff --git a/internal/config/types.go b/internal/config/types.go
@@ -105,14 +105,14 @@ type (
 	}
 
 	Collector struct {
-		ConfigPath string     `yaml:"config_path" mapstructure:"config_path"`
-		AdditionalPaths []string `yaml:"additional_config_paths" mapstructure:"additional_config_paths"`
-		Log        *Log       `yaml:"log"         mapstructure:"log"`
-		Exporters  Exporters  `yaml:"exporters"   mapstructure:"exporters"`
-		Extensions Extensions `yaml:"extensions"  mapstructure:"extensions"`
-		Processors Processors `yaml:"processors"  mapstructure:"processors"`
-		Pipelines  Pipelines  `yaml:"pipelines"   mapstructure:"pipelines"`
-		Receivers  Receivers  `yaml:"receivers"   mapstructure:"receivers"`
+		ConfigPath      string     `yaml:"config_path"             mapstructure:"config_path"`
+		AdditionalPaths []string   `yaml:"additional_config_paths" mapstructure:"additional_config_paths"`
+		Log             *Log       `yaml:"log"                     mapstructure:"log"`
+		Exporters       Exporters  `yaml:"exporters"               mapstructure:"exporters"`
+		Extensions      Extensions `yaml:"extensions"              mapstructure:"extensions"`
+		Processors      Processors `yaml:"processors"              mapstructure:"processors"`
+		Pipelines       Pipelines  `yaml:"pipelines"               mapstructure:"pipelines"`
+		Receivers       Receivers  `yaml:"receivers"               mapstructure:"receivers"`
 	}
 
 	Pipelines struct {
diff --git a/test/config/collector/test-opentelemetry-collector-agent.yaml b/test/config/collector/test-opentelemetry-collector-agent.yaml
@@ -26,7 +26,8 @@ receivers:
           cert_file: /tmp/cert.pem
           key_file: /tmp/key.pem
           ca_file: /tmp/ca.pem
-  nginx/123:
+  nginx:
+    instance_id: "123"
     api_details:
       url: "http://localhost:80/status"
       listen: ""
@@ -36,6 +37,22 @@ receivers:
     access_logs:
       - log_format: "$remote_addr - $remote_user [$time_local] \"$request\" $status $body_bytes_sent \"$http_referer\" \"$http_user_agent\" \"$http_x_forwarded_for\"\"$upstream_cache_status\""
         file_path: "/var/log/nginx/access-custom.conf"
+  nginxplus/456:
+    instance_id: "456"
+    api_details:
+      url: "http://localhost:80/api"
+      listen: ""
+      location: ""
+      ca: ""
+    collection_interval: 20s
+  nginxplus/789:
+    instance_id: "789"
+    api_details:
+      url: "http://localhost:90/api"
+      listen: ""
+      location: ""
+      ca: ""
+    collection_interval: 20s
   tcplog/default:
     listen_address: "localhost:151"
     operators:
@@ -108,7 +125,9 @@ service:
         - hostmetrics
         - containermetrics
         - otlp/default
-        - nginx/123
+        - nginx
+        - nginxplus/456
+        - nginxplus/789
       processors:
         - resource/default
         - batch/default

Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ func (s *NginxStubStatusScraper) Scrape(context.Context) (pmetric.Metrics, error`
`138`	`138`	`return pmetric.Metrics{}, err`
`139`	`139`	`}`
`140`	`140`
`141`		`- s.rb.SetInstanceID(s.settings.ID.Name())`
	`141`	`+ s.rb.SetInstanceID(s.cfg.InstanceID)`
`142`	`142`	`s.rb.SetInstanceType("nginx")`
`143`	`143`	`s.settings.Logger.Debug("NGINX OSS stub status resource info", zap.Any("resource", s.rb))`
`144`	`144`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ const defaultCollectInterval = 10 * time.Second`
`21`	`21`	`type Config struct {`
`22`	`22`	confighttp.ClientConfig `mapstructure:",squash"`
`23`	`23`	APIDetails APIDetails `mapstructure:"api_details"`
	`24`	+ InstanceID string `mapstructure:"instance_id"`
`24`	`25`	MetricsBuilderConfig metadata.MetricsBuilderConfig `mapstructure:",squash"`
`25`	`26`	scraperhelper.ControllerConfig `mapstructure:",squash"`
`26`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ func (nps *NginxPlusScraper) Scrape(ctx context.Context) (pmetric.Metrics, error`
`127`	`127`	`return pmetric.Metrics{}, fmt.Errorf("failed to get stats from plus API: %w", err)`
`128`	`128`	`}`
`129`	`129`
`130`		`- nps.rb.SetInstanceID(nps.settings.ID.Name())`
	`130`	`+ nps.rb.SetInstanceID(nps.cfg.InstanceID)`
`131`	`131`	`nps.rb.SetInstanceType("nginxplus")`
`132`	`132`	`nps.logger.Debug("NGINX Plus resource info", zap.Any("resource", nps.rb))`
`133`	`133`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,11 @@ func createConverterFactories() []confmap.ConverterFactory {`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`func createURIs(cfg *config.Config) []string {`
`74`		`- return []string{cfg.Collector.ConfigPath}`
	`74`	`+ configFiles := []string{cfg.Collector.ConfigPath}`
	`75`	`+ configFiles = slices.Concat(configFiles, cfg.Collector.AdditionalPaths)`
	`76`	`+ slog.Info("Additional config files:", "", configFiles)`
	`77`	`+`
	`78`	`+ return configFiles`
`75`	`79`	`}`
`76`	`80`
`77`	`81`	`func createFile(confPath string) error {`