disk

Documentation

Overview

Package disk tracks the disk usage of all the mount points specified in the configuration.

Index

• Constants
• func CreateGet(cfg Config) query.GetFunc
• func New(ctx context.Context, cfg Config) components.Component
• type Config
  • func DefaultConfig() Config
  • func ParseConfig(b any, db *sql.DB) (*Config, error)
  • func (cfg Config) Validate() error
• type Output
  • func (o *Output) States() ([]components.State, error)

Constants

const (
	StateNameDiskExtPartition  = "disk_ext_partition"
	StateNameDiskBlockDevices  = "disk_block_devices"
	StateNameMountTargetUsages = "mount_target_usages"

	StateKeyData           = "data"
	StateKeyEncoding       = "encoding"
	StateValueEncodingJSON = "json"

	StateNameDiskBlockDevicesTotal         = "disk_block_devices_total"
	StateKeyDiskBlockDevicesTotalBytes     = "disk_block_devices_total_bytes"
	StateKeyDiskBlockDevicesTotalGB        = "disk_block_devices_total_gb"
	StateKeyDiskBlockDevicesTotalHumanized = "disk_block_devices_total_humanized"

	StateNameDiskExtPartitionsTotal         = "disk_ext_partitions_total"
	StateKeyDiskExtPartitionsTotalBytes     = "disk_ext_partitions_total_bytes"
	StateKeyDiskExtPartitionsTotalGB        = "disk_ext_partitions_total_gb"
	StateKeyDiskExtPartitionsTotalHumanized = "disk_ext_partitions_total_humanized"
)

Functions

func CreateGet

func CreateGet(cfg Config) query.GetFunc

func New

func New(ctx context.Context, cfg Config) components.Component

Types

type Config

type Config struct {
	Query query_config.Config `json:"query"`

	// Specifies the mount points to track the disk usage for (e.g., metrics).
	MountPointsToTrackUsage []string `json:"mount_points_to_track_usage"`

	// Mount targets to track the disk usage for (e.g., /var/lib/kubelet).
	MountTargetsToTrackUsage []string `json:"mount_targets_to_track_usage"`
}

func DefaultConfig

func DefaultConfig() Config

func ParseConfig

func ParseConfig(b any, db *sql.DB) (*Config, error)

func (Config) Validate

func (cfg Config) Validate() error

type Output

type Output struct {
	DiskExtPartitions disk.Partitions               `json:"disk_ext_partitions"`
	DiskBlockDevices  disk.BlockDevices             `json:"disk_block_devices"`
	MountTargetUsages map[string]disk.FindMntOutput `json:"mount_target_usages"`
}

func (*Output) States

func (o *Output) States() ([]components.State, error)