ob-col/receiver/purefareceiver/config.go

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package purefareceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/purefareceiver"

import (
	"errors"
	"time"

	"go.opentelemetry.io/collector/component"
	"go.opentelemetry.io/collector/config/confighttp"
	"go.uber.org/multierr"

	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/purefareceiver/internal"
)

var _ component.Config = (*Config)(nil)

// Config relating to Array Metric Scraper.
type Config struct {
	confighttp.HTTPClientSettings `mapstructure:",squash"`

	// Settings contains settings for the individual scrapers
	Settings *Settings `mapstructure:"settings"`

	// Array represents the list of arrays to query
	Array []internal.ScraperConfig `mapstructure:"array"`

	// Hosts represents the list of hosts to query
	Hosts []internal.ScraperConfig `mapstructure:"hosts"`

	// Directories represents the list of directories to query
	Directories []internal.ScraperConfig `mapstructure:"directories"`

	// Pods represents the list of pods to query
	Pods []internal.ScraperConfig `mapstructure:"pods"`

	// Volumes represents the list of volumes to query
	Volumes []internal.ScraperConfig `mapstructure:"volumes"`

	// Env represents the respective environment value valid to scrape
	Env string `mapstructure:"env"`

	// ArrayName represents the display name that is appended to the received metrics, as the `host` label if not provided by OpenMetrics output, and to the `fa_array_name` label always.
	ArrayName string `mapstructure:"fa_array_name"`
}

type Settings struct {
	ReloadIntervals *ReloadIntervals `mapstructure:"reload_intervals"`
}

type ReloadIntervals struct {
	Array       time.Duration `mapstructure:"array"`
	Hosts       time.Duration `mapstructure:"hosts"`
	Directories time.Duration `mapstructure:"directories"`
	Pods        time.Duration `mapstructure:"pods"`
	Volumes     time.Duration `mapstructure:"volumes"`
}

func (c *Config) Validate() error {
	var errs error

	if c.ArrayName == "" {
		errs = multierr.Append(errs, errors.New("the array's pretty name as 'fa_array_name' must be provided"))
	}
	if c.Settings.ReloadIntervals.Array == 0 {
		errs = multierr.Append(errs, errors.New("reload interval for 'array' must be provided"))
	}
	if c.Settings.ReloadIntervals.Hosts == 0 {
		errs = multierr.Append(errs, errors.New("reload interval for 'hosts' must be provided"))
	}
	if c.Settings.ReloadIntervals.Directories == 0 {
		errs = multierr.Append(errs, errors.New("reload interval for 'directories' must be provided"))
	}
	if c.Settings.ReloadIntervals.Pods == 0 {
		errs = multierr.Append(errs, errors.New("reload interval for 'pods' must be provided"))
	}
	if c.Settings.ReloadIntervals.Volumes == 0 {
		errs = multierr.Append(errs, errors.New("reload interval for 'volumes' must be provided"))
	}

	return errs
}