feat: add receiver config and factory go

steven-freed · steven-freed · commit 0a79d9ec5208 · 2025-10-08T11:33:28.000-04:00
Signed-off-by: Steve Freed &lt;freedgitr@gmail.com&gt;
diff --git a/receiver/redfishreceiver/config.go b/receiver/redfishreceiver/config.go
@@ -0,0 +1,54 @@
+package redfishreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redfishreceiver"
+
+import (
+	"fmt"
+	"time"
+
+	"go.opentelemetry.io/collector/config/configopaque"
+	"go.opentelemetry.io/collector/scraper/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redfishreceiver/internal/metadata"
+)
+
+type redfishConfig struct {
+	Version string `mapstructure:"version"`
+}
+
+type Server struct {
+	Host             string              `mapstructure:"host"`
+	User             string              `mapstructure:"username"`
+	Pwd              configopaque.String `mapstructure:"password"`
+	Insecure         bool                `mapstructure:"insecure"`
+	Timeout          string              `mapstructure:"timeout"`
+	Redfish          redfishConfig       `mapstructure:"redfish"`
+	ComputerSystemId string              `mapstructure:"computer_system_id"`
+	Resources        []Resource          `mapstructure:"resources"`
+}
+
+type Config struct {
+	scraperhelper.ControllerConfig `mapstructure:",squash"`
+	metadata.MetricsBuilderConfig  `mapstructure:",squash"`
+	Servers                        []Server `mapstructure:"servers"`
+
+	// prevent unkeyed literal initialization
+	_ struct{}
+}
+
+func (cfg *Config) Validate() error {
+	if len(cfg.Servers) == 0 {
+		return fmt.Errorf("servers must not be empty")
+	}
+
+	for _, server := range cfg.Servers {
+		if server.Redfish.Version != "v1" {
+			return fmt.Errorf("redfish version must be once of the following values: 'v1'")
+		}
+		if len(server.Resources) == 0 {
+			return fmt.Errorf("resources must not be empty")
+		}
+		if _, err := time.ParseDuration(server.Timeout); err != nil && server.Timeout != "" {
+			return fmt.Errorf("invalid server timeout")
+		}
+	}
+	return nil
+}
diff --git a/receiver/redfishreceiver/factory.go b/receiver/redfishreceiver/factory.go
@@ -0,0 +1,51 @@
+package redfishreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redfishreceiver"
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/consumer"
+	"go.opentelemetry.io/collector/receiver"
+	"go.opentelemetry.io/collector/scraper"
+	"go.opentelemetry.io/collector/scraper/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redfishreceiver/internal/metadata"
+)
+
+var typeStr = component.MustNewType("redfishreceiver")
+
+func createDefaultConfig() component.Config {
+	cfg := scraperhelper.NewDefaultControllerConfig()
+	cfg.CollectionInterval = 60 * time.Second
+
+	return &Config{
+		ControllerConfig:     cfg,
+		MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
+		Servers:              make([]Server, 0),
+	}
+}
+
+func createMetricsReceiver(_ context.Context, params receiver.Settings, baseCfg component.Config, consumer consumer.Metrics) (receiver.Metrics, error) {
+	cfg, ok := baseCfg.(*Config)
+	if !ok {
+		return nil, fmt.Errorf("invalid redfishreceiver config")
+	}
+
+	redfishScraper := newScraper(cfg, params)
+	s, err := scraper.NewMetrics(redfishScraper.scrape, scraper.WithStart(redfishScraper.start))
+	if err != nil {
+		return nil, err
+	}
+
+	return scraperhelper.NewMetricsController(&cfg.ControllerConfig, params, consumer, scraperhelper.AddScraper(metadata.Type, s))
+}
+
+// NewFactory creates a factory for redfish receiver.
+func NewFactory() receiver.Factory {
+	return receiver.NewFactory(
+		typeStr,
+		createDefaultConfig,
+		receiver.WithMetrics(createMetricsReceiver, component.StabilityLevelAlpha))
+}
