cpuscraper

Documentation

Index

• Constants
• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() internal.Config
  • func (f *Factory) CreateMetricsScraper(ctx context.Context, _ *zap.Logger, config internal.Config) (internal.Scraper, error)

Constants

const (
	// The value of "type" key in configuration.
	TypeStr = "cpu"
)

Types

type Config

type Config struct {
	internal.ConfigSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct

	// If `true`, stats will be generated for the system as a whole _as well
	// as_ for each individual CPU/core in the system and will be distinguished
	// by the `cpu` dimension.  If `false`, stats will only be generated for
	// the system as a whole that will not include a `cpu` dimension.
	ReportPerCPU bool `mapstructure:"report_per_cpu"`
}

Config relating to CPU Metric Scraper.

type Factory

type Factory struct {
}

Factory is the Factory for scraper.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() internal.Config

CreateDefaultConfig creates the default configuration for the Scraper.

func (*Factory) CreateMetricsScraper

func (f *Factory) CreateMetricsScraper(
	ctx context.Context,
	_ *zap.Logger,
	config internal.Config,
) (internal.Scraper, error)

CreateMetricsScraper creates a scraper based on provided config.