Update host metrics receiver to use receiverhelper

obsreport/obsreporttest/obsreporttest.go

@@ -168,6 +168,8 @@ func tagsForScraperView(scraper string) []tag.Tag {
 	return []tag.Tag{
 		{Key: scraperTag, Value: scraper},
 	}
+
+	return tags
 }
 
 // tagsForProcessorView returns the tags that are needed for the processor views.

receiver/hostmetricsreceiver/config.go

@@ -15,16 +15,12 @@
 package hostmetricsreceiver
 
 import (
-	"time"
-
-	"go.opentelemetry.io/collector/config/configmodels"
 	"go.opentelemetry.io/collector/receiver/hostmetricsreceiver/internal"
+	"go.opentelemetry.io/collector/receiver/receiverhelper"
 )
 
 // Config defines configuration for HostMetrics receiver.
 type Config struct {
-	configmodels.ReceiverSettings `mapstructure:",squash"`
-
-	CollectionInterval time.Duration              `mapstructure:"collection_interval"`
-	Scrapers           map[string]internal.Config `mapstructure:"-"`
+	receiverhelper.ScraperControllerSettings `mapstructure:",squash"`
+	Scrapers                                 map[string]internal.Config `mapstructure:"-"`
 }

receiver/hostmetricsreceiver/config_test.go

@@ -36,6 +36,7 @@ import (
 	"go.opentelemetry.io/collector/receiver/hostmetricsreceiver/internal/scraper/processesscraper"
 	"go.opentelemetry.io/collector/receiver/hostmetricsreceiver/internal/scraper/processscraper"
 	"go.opentelemetry.io/collector/receiver/hostmetricsreceiver/internal/scraper/swapscraper"
+	"go.opentelemetry.io/collector/receiver/receiverhelper"
 )
 
 func TestLoadConfig(t *testing.T) {
@@ -61,11 +62,13 @@ func TestLoadConfig(t *testing.T) {
 
 	r1 := cfg.Receivers["hostmetrics/customname"].(*Config)
 	expectedConfig := &Config{
-		ReceiverSettings: configmodels.ReceiverSettings{
-			TypeVal: typeStr,
-			NameVal: "hostmetrics/customname",
+		ScraperControllerSettings: receiverhelper.ScraperControllerSettings{
+			ReceiverSettings: configmodels.ReceiverSettings{
+				TypeVal: typeStr,
+				NameVal: "hostmetrics/customname",
+			},
+			CollectionInterval: 30 * time.Second,
 		},
-		CollectionInterval: 30 * time.Second,
 		Scrapers: map[string]internal.Config{
 			cpuscraper.TypeStr:        &cpuscraper.Config{},
 			diskscraper.TypeStr:       &diskscraper.Config{},

receiver/hostmetricsreceiver/factory.go

@@ -18,9 +18,9 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"time"
 
 	"github.com/spf13/viper"
+	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config"
@@ -88,10 +88,6 @@ func customUnmarshaler(componentViperSection *viper.Viper, intoCfg interface{})
 		return fmt.Errorf("config type not hostmetrics.Config")
 	}
 
-	if cfg.CollectionInterval <= 0 {
-		return fmt.Errorf("collection_interval must be a positive duration")
-	}
-
 	// dynamically load the individual collector configs based on the key name
 
 	cfg.Scrapers = map[string]internal.Config{}
@@ -140,13 +136,7 @@ func getScraperFactory(key string) (internal.BaseFactory, bool) {
 
 // createDefaultConfig creates the default configuration for receiver.
 func createDefaultConfig() configmodels.Receiver {
-	return &Config{
-		ReceiverSettings: configmodels.ReceiverSettings{
-			TypeVal: typeStr,
-			NameVal: typeStr,
-		},
-		CollectionInterval: time.Minute,
-	}
+	return &Config{ScraperControllerSettings: receiverhelper.DefaultScraperControllerSettings(typeStr)}
 }
 
 // createMetricsReceiver creates a metrics receiver based on provided config.
@@ -158,10 +148,74 @@ func createMetricsReceiver(
 ) (component.MetricsReceiver, error) {
 	oCfg := cfg.(*Config)
 
-	hmr, err := newHostMetricsReceiver(ctx, params.Logger, oCfg, scraperFactories, resourceScraperFactories, consumer)
+	addScraperOptions, err := createAddScraperOptions(ctx, params.Logger, oCfg, scraperFactories, resourceScraperFactories)
 	if err != nil {
 		return nil, err
 	}
 
-	return hmr, nil
+	return receiverhelper.NewScraperControllerReceiver(
+		&oCfg.ScraperControllerSettings,
+		consumer,
+		addScraperOptions...,
+	)
+}
+
+func createAddScraperOptions(
+	ctx context.Context,
+	logger *zap.Logger,
+	config *Config,
+	factories map[string]internal.ScraperFactory,
+	resourceFactories map[string]internal.ResourceScraperFactory,
+) ([]receiverhelper.ScraperControllerOption, error) {
+	scraperControllerOptions := make([]receiverhelper.ScraperControllerOption, 0, len(config.Scrapers))
+
+	for key, cfg := range config.Scrapers {
+		hostMetricsScraper, ok, err := createHostMetricsScraper(ctx, logger, key, cfg, factories)
+		if err != nil {
+			return nil, fmt.Errorf("failed to create scraper for key %q: %w", key, err)
+		}
+
+		if ok {
+			scraperControllerOptions = append(scraperControllerOptions, receiverhelper.AddMetricsScraper(hostMetricsScraper))
+			continue
+		}
+
+		resourceMetricsScraper, ok, err := createResourceMetricsScraper(ctx, logger, key, cfg, resourceFactories)
+		if err != nil {
+			return nil, fmt.Errorf("failed to create resource scraper for key %q: %w", key, err)
+		}
+
+		if ok {
+			scraperControllerOptions = append(scraperControllerOptions, receiverhelper.AddResourceMetricsScraper(resourceMetricsScraper))
+			continue
+		}
+
+		return nil, fmt.Errorf("host metrics scraper factory not found for key: %q", key)
+	}
+
+	return scraperControllerOptions, nil
+}
+
+func createHostMetricsScraper(ctx context.Context, logger *zap.Logger, key string, cfg internal.Config, factories map[string]internal.ScraperFactory) (scraper receiverhelper.MetricsScraper, ok bool, err error) {
+	factory := factories[key]
+	if factory == nil {
+		ok = false
+		return
+	}
+
+	ok = true
+	scraper, err = factory.CreateMetricsScraper(ctx, logger, cfg)
+	return
+}
+
+func createResourceMetricsScraper(ctx context.Context, logger *zap.Logger, key string, cfg internal.Config, factories map[string]internal.ResourceScraperFactory) (scraper receiverhelper.ResourceMetricsScraper, ok bool, err error) {
+	factory := factories[key]
+	if factory == nil {
+		ok = false
+		return
+	}
+
+	ok = true
+	scraper, err = factory.CreateMetricsScraper(ctx, logger, cfg)
+	return
 }

receiver/hostmetricsreceiver/factory_test.go

@@ -25,6 +25,7 @@ import (
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configcheck"
 	"go.opentelemetry.io/collector/config/configerror"
+	"go.opentelemetry.io/collector/exporter/exportertest"
 	"go.opentelemetry.io/collector/receiver/hostmetricsreceiver/internal"
 )
 
@@ -41,12 +42,12 @@ func TestCreateReceiver(t *testing.T) {
 	factory := NewFactory()
 	cfg := factory.CreateDefaultConfig()
 
-	tReceiver, err := factory.CreateTraceReceiver(context.Background(), creationParams, cfg, nil)
+	tReceiver, err := factory.CreateTraceReceiver(context.Background(), creationParams, cfg, &exportertest.SinkTraceExporter{})
 
 	assert.Equal(t, err, configerror.ErrDataTypeIsNotSupported)
 	assert.Nil(t, tReceiver)
 
-	mReceiver, err := factory.CreateMetricsReceiver(context.Background(), creationParams, cfg, nil)
+	mReceiver, err := factory.CreateMetricsReceiver(context.Background(), creationParams, cfg, &exportertest.SinkMetricsExporter{})
 
 	assert.NoError(t, err)
 	assert.NotNil(t, mReceiver)
@@ -58,6 +59,6 @@ func TestCreateReceiver_ScraperKeyConfigError(t *testing.T) {
 	factory := NewFactory()
 	cfg := &Config{Scrapers: map[string]internal.Config{errorKey: &mockConfig{}}}
 
-	_, err := factory.CreateMetricsReceiver(context.Background(), creationParams, cfg, nil)
+	_, err := factory.CreateMetricsReceiver(context.Background(), creationParams, cfg, &exportertest.SinkMetricsExporter{})
 	assert.EqualError(t, err, fmt.Sprintf("host metrics scraper factory not found for key: %q", errorKey))
 }