Documentation

Index

Constants

View Source
const (
	// The value of "type" key in configuration.
	TypeStr = "filesystem"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

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

	// IncludeDevices specifies a filter on the devices that should be included in the generated metrics.
	IncludeDevices DeviceMatchConfig `mapstructure:"include_devices"`
	// ExcludeDevices specifies a filter on the devices that should be excluded from the generated metrics.
	ExcludeDevices DeviceMatchConfig `mapstructure:"exclude_devices"`

	// IncludeFSTypes specifies a filter on the filesystem types that should be included in the generated metrics.
	IncludeFSTypes FSTypeMatchConfig `mapstructure:"include_fs_types"`
	// ExcludeFSTypes specifies a filter on the filesystem types points that should be excluded from the generated metrics.
	ExcludeFSTypes FSTypeMatchConfig `mapstructure:"exclude_fs_types"`

	// IncludeMountPoints specifies a filter on the mount points that should be included in the generated metrics.
	IncludeMountPoints MountPointMatchConfig `mapstructure:"include_mount_points"`
	// ExcludeMountPoints specifies a filter on the mount points that should be excluded from the generated metrics.
	ExcludeMountPoints MountPointMatchConfig `mapstructure:"exclude_mount_points"`
}

    Config relating to FileSystem Metric Scraper.

    type DeviceMatchConfig

    type DeviceMatchConfig struct {
    	filterset.Config `mapstructure:",squash"`
    
    	Devices []string `mapstructure:"devices"`
    }

    type FSTypeMatchConfig

    type FSTypeMatchConfig struct {
    	filterset.Config `mapstructure:",squash"`
    
    	FSTypes []string `mapstructure:"fs_types"`
    }

    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,
        ) (scraperhelper.MetricsScraper, error)

          CreateMetricsScraper creates a scraper based on provided config.

          func (*Factory) Type

          func (f *Factory) Type() string

            Type gets the type of the scraper config created by this Factory.

            type MountPointMatchConfig

            type MountPointMatchConfig struct {
            	filterset.Config `mapstructure:",squash"`
            
            	MountPoints []string `mapstructure:"mount_points"`
            }
            GOOS=linux, GOARCH=amd64