Status reporter extension.

Status reporter extension.

Author: sureshbabu-areekara

cmd/otelcontribcol/builder-config.yaml

@@ -58,6 +58,7 @@ extensions:
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/googlecloudlogentryencodingextension v0.136.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/k8sleaderelector v0.136.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/cgroupruntimeextension v0.136.0
+  - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/statusreporterextension v0.136.0
 
 exporters:
   - gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.136.1-0.20251002223229-5ec1466578ef

extension/statusreporterextension/config.go

@@ -0,0 +1,13 @@
+package statusreporterextension
+
+// Config holds the configuration for the statusreporter extension.
+// This extension exposes health information about the collector at the "/api/otel-status" endpoint.
+type Config struct {
+	MetricsEndpoint string `mapstructure:"metrics_endpoint"` // endpoint to scrape metrics from
+	StaleThreshold  int    `mapstructure:"stale_threshold"`  // threshold in seconds to consider data stale
+	EngineID        string `mapstructure:"engine_id"`        // identifier for the engine (e.g., presto-01)
+	PodName         string `mapstructure:"pod_name"`         // name of the pod where OTeL sidecar is attached
+	Port            int    `mapstructure:"port"`             // port on which the status reporter server listens
+	AuthEnabled     bool   `mapstructure:"auth_enabled"`     // whether authentication is enabled
+	SecretValue     string `mapstructure:"secret_value"`     // fallback secret value if LH_INSTANCE_SECRET is not set
+}

extension/statusreporterextension/config_test.go

@@ -0,0 +1,84 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package statusreporterextension
+
+import (
+	"testing"
+)
+
+func TestConfigValidation(t *testing.T) {
+	// Test with default config
+	cfg := createDefaultConfig().(*Config)
+	if cfg.MetricsEndpoint != "http://localhost:8888/metrics" {
+		t.Errorf("Expected default MetricsEndpoint to be http://localhost:8888/metrics, got %s", cfg.MetricsEndpoint)
+	}
+	
+	// Test with custom values
+	cfg.MetricsEndpoint = "http://custom:9090/metrics"
+	cfg.StaleThreshold = 600
+	cfg.EngineID = "custom-engine"
+	cfg.PodName = "custom-pod"
+	cfg.Port = 9000
+	cfg.AuthEnabled = true
+	cfg.SecretValue = "custom-secret"
+	
+	// Verify custom values
+	if cfg.MetricsEndpoint != "http://custom:9090/metrics" {
+		t.Errorf("Failed to set custom MetricsEndpoint")
+	}
+	
+	if cfg.StaleThreshold != 600 {
+		t.Errorf("Failed to set custom StaleThreshold")
+	}
+	
+	if cfg.EngineID != "custom-engine" {
+		t.Errorf("Failed to set custom EngineID")
+	}
+	
+	if cfg.PodName != "custom-pod" {
+		t.Errorf("Failed to set custom PodName")
+	}
+	
+	if cfg.Port != 9000 {
+		t.Errorf("Failed to set custom Port")
+	}
+	
+	if !cfg.AuthEnabled {
+		t.Errorf("Failed to set custom AuthEnabled")
+	}
+	
+	if cfg.SecretValue != "custom-secret" {
+		t.Errorf("Failed to set custom SecretValue")
+	}
+}
+
+func TestConfigEdgeCases(t *testing.T) {
+	cfg := createDefaultConfig().(*Config)
+	
+	// Test with empty metrics endpoint
+	cfg.MetricsEndpoint = ""
+	// This should be allowed, as the extension will use a default value
+	
+	// Test with negative stale threshold
+	cfg.StaleThreshold = -1
+	// This should be allowed, though it might not be practical
+	
+	// Test with zero port (should use system-assigned port)
+	cfg.Port = 0
+	// This should be allowed, as the HTTP server can use a system-assigned port
+	
+	// Test with empty engine ID
+	cfg.EngineID = ""
+	// This should be allowed, though it might not be useful
+	
+	// Test with empty pod name
+	cfg.PodName = ""
+	// This should be allowed, though it might not be useful
+	
+	// Test with auth enabled but empty secret
+	cfg.AuthEnabled = true
+	cfg.SecretValue = ""
+	// This should be allowed, as the secret might be provided via environment variable
+}
+