Update extensions config for Otel collector

nginx · Sep 16, 2024 · 268d805 · 268d805
1 parent 70a78e7
commit 268d805
Show file tree

Hide file tree

Showing 10 changed files with 66 additions and 37 deletions.
diff --git a/internal/collector/nginxossreceiver/internal/metadata/generated_status.go b/internal/collector/nginxossreceiver/internal/metadata/generated_status.go
diff --git a/internal/collector/nginxplusreceiver/internal/metadata/generated_status.go b/internal/collector/nginxplusreceiver/internal/metadata/generated_status.go
diff --git a/internal/collector/otelcol.tmpl b/internal/collector/otelcol.tmpl
@@ -78,13 +78,22 @@ exporters:
 {{- end }}
 {{- end }}
 
+{{- if ne .Extensions nil }}
 extensions:
+  {{- if ne .Extensions.Health nil }}
   health_check:
-    {{- if .Health }}
-    endpoint: "{{ .Health.Host -}}:{{- .Health.Port }}"
-    {{- else }}
-    endpoint: "localhost:13133"
+    endpoint: "{{ .Extensions.Health.Server.Host -}}:{{- .Extensions.Health.Server.Port }}"
+    {{- if ne .Extensions.Health.Path "" }}
+    path: "{{ .Extensions.Health.Path -}}"
     {{- end }}
+    {{- if ne .Extensions.Health.TLS nil }}
+    tls: 
+       ca_cert: "{{ .Extensions.Health.Server.TLS.Ca -}}"
+       cert_file: "{{ .Extensions.Health.Server.TLS.Cert -}}"
+       key_file: "{{ .Extensions.Health.Server.TLS.Key -}}"
+    {{- end }}
+  {{- end }}
+{{- end }}
 
 service:
   {{- if .Log.Path}}

diff --git a/internal/config/config.go b/internal/config/config.go
@@ -344,20 +344,20 @@ func resolveCollector(allowedDirs []string) (*Collector, error) {
 	}
 
 	var (
-		err         error
-		exporters   []Exporter
-		processors  []Processor
-		receivers   Receivers
-		healthCheck ServerConfig
-		log         Log
+		err        error
+		exporters  []Exporter
+		processors []Processor
+		receivers  Receivers
+		extensions Extensions
+		log        Log
 	)
 
 	err = errors.Join(
 		err,
 		resolveMapStructure(CollectorExportersKey, &exporters),
 		resolveMapStructure(CollectorProcessorsKey, &processors),
 		resolveMapStructure(CollectorReceiversKey, &receivers),
-		resolveMapStructure(CollectorHealthKey, &healthCheck),
+		resolveMapStructure(CollectorExtensionsKey, &extensions),
 		resolveMapStructure(CollectorLogKey, &log),
 	)
 	if err != nil {
@@ -377,7 +377,7 @@ func resolveCollector(allowedDirs []string) (*Collector, error) {
 		Exporters:  exporters,
 		Processors: processors,
 		Receivers:  receivers,
-		Health:     &healthCheck,
+		Extensions: extensions,
 		Log:        &log,
 	}
 

diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -53,7 +53,7 @@ func TestResolveConfig(t *testing.T) {
 	assert.True(t, viperInstance.IsSet(CollectorExportersKey))
 	assert.True(t, viperInstance.IsSet(CollectorProcessorsKey))
 	assert.True(t, viperInstance.IsSet(CollectorReceiversKey))
-	assert.True(t, viperInstance.IsSet(CollectorHealthKey))
+	assert.True(t, viperInstance.IsSet(CollectorExtensionsKey))
 
 	actual, err := ResolveConfig()
 	require.NoError(t, err)
@@ -69,7 +69,7 @@ func TestResolveConfig(t *testing.T) {
 	assert.NotEmpty(t, actual.Collector.Receivers)
 	assert.NotEmpty(t, actual.Collector.Processors)
 	assert.NotEmpty(t, actual.Collector.Exporters)
-	assert.NotEmpty(t, actual.Collector.Health)
+	assert.NotEmpty(t, actual.Collector.Extensions)
 
 	assert.Equal(t, 10*time.Second, actual.Client.Timeout)
 
@@ -225,7 +225,7 @@ func TestResolveCollector(t *testing.T) {
 			viperInstance.Set(CollectorReceiversKey, test.expected.Receivers)
 			viperInstance.Set(CollectorProcessorsKey, test.expected.Processors)
 			viperInstance.Set(CollectorExportersKey, test.expected.Exporters)
-			viperInstance.Set(CollectorHealthKey, test.expected.Health)
+			viperInstance.Set(CollectorExtensionsKey, test.expected.Extensions)
 			viperInstance.Set(CollectorLogKey, test.expected.Log)
 
 			actual, err := resolveCollector(testDefault.AllowedDirectories)
@@ -394,10 +394,14 @@ func getAgentConfig() *Config {
 					},
 				},
 			},
-			Health: &ServerConfig{
-				Host: "localhost",
-				Port: 1337,
-				Type: 0,
+			Extensions: Extensions{
+				Health: Health{
+					Server: &ServerConfig{
+						Host: "localhost",
+						Port: 1337,
+						Type: 0,
+					},
+				},
 			},
 			Log: &Log{
 				Level: "INFO",

diff --git a/internal/config/flags.go b/internal/config/flags.go
@@ -34,7 +34,7 @@ var (
 	CollectorConfigPathKey         = pre(CollectorRootKey) + "config_path"
 	CollectorExportersKey          = pre(CollectorRootKey) + "exporters"
 	CollectorProcessorsKey         = pre(CollectorRootKey) + "processors"
-	CollectorHealthKey             = pre(CollectorRootKey) + "health"
+	CollectorExtensionsKey         = pre(CollectorRootKey) + "extensions"
 	CollectorReceiversKey          = pre(CollectorRootKey) + "receivers"
 	CollectorLogKey                = pre(CollectorRootKey) + "log"
 	CollectorLogLevelKey           = pre(CollectorLogKey) + "level"

diff --git a/internal/config/testdata/nginx-agent.conf b/internal/config/testdata/nginx-agent.conf
@@ -55,9 +55,10 @@ collector:
         cert: /path/to/server-cert.pem
         key: /path/to/server-key.pem
         ca: /path/to/server-cert.pem
-  health:
-    host: "127.0.0.1"
-    port: 1234
-    type: 0
+  extensions:
+    health:
+      server:
+        host: "127.0.0.1"
+        port: 1234
 
 config_dirs: "/etc/nginx:/usr/local/etc/nginx:/var/run/nginx:/usr/share/nginx/modules:/var/log/nginx:invalid/path"
diff --git a/internal/config/types.go b/internal/config/types.go
@@ -85,12 +85,22 @@ type (
 	}
 
 	Collector struct {
-		ConfigPath string        `yaml:"-" mapstructure:"config_path"`
-		Log        *Log          `yaml:"-" mapstructure:"log"`
-		Exporters  []Exporter    `yaml:"-" mapstructure:"exporters"`
-		Health     *ServerConfig `yaml:"-" mapstructure:"health"`
-		Processors []Processor   `yaml:"-" mapstructure:"processors"`
-		Receivers  Receivers     `yaml:"-" mapstructure:"receivers"`
+		ConfigPath string      `yaml:"-" mapstructure:"config_path"`
+		Log        *Log        `yaml:"-" mapstructure:"log"`
+		Exporters  []Exporter  `yaml:"-" mapstructure:"exporters"`
+		Extensions Extensions  `yaml:"-" mapstructure:"extensions"`
+		Processors []Processor `yaml:"-" mapstructure:"processors"`
+		Receivers  Receivers   `yaml:"-" mapstructure:"receivers"`
+	}
+
+	Extensions struct {
+		Health Health `yaml:"-" mapstructure:"health"`
+	}
+
+	Health struct {
+		Server *ServerConfig `yaml:"-" mapstructure:"server"`
+		TLS    *TLSConfig    `yaml:"-" mapstructure:"tls"`
+		Path   string        `yaml:"-" mapstructure:"path"`
 	}
 
 	// OTel Collector Exporter configuration.

diff --git a/test/config/collector/test-opentelemetry-collector-agent.yaml b/test/config/collector/test-opentelemetry-collector-agent.yaml
@@ -43,7 +43,6 @@ exporters:
     verbosity: detailed
     sampling_initial: 5
     sampling_thereafter: 200
-
 extensions:
   health_check:
     endpoint: "localhost:1337"

diff --git a/test/types/config.go b/test/types/config.go
@@ -76,10 +76,14 @@ func AgentConfig() *config.Config {
 					InitialDelay:       time.Second,
 				},
 			},
-			Health: &config.ServerConfig{
-				Host: "localhost",
-				Port: randomPort3,
-				Type: 0,
+			Extensions: config.Extensions{
+				Health: config.Health{
+					Server: &config.ServerConfig{
+						Host: "localhost",
+						Port: randomPort3,
+						Type: 0,
+					},
+				},
 			},
 			Log: &config.Log{
 				Level: "INFO",