metadata

Documentation

Index

• Constants
• Variables
• type MetricIntf

Constants

const Type config.Type = "filesystem"

Type is the component type name.

Variables

var A = Attributes

A is an alias for Attributes.

var AttributeState = struct {
	Free     string
	Reserved string
	Used     string
}{
	"free",
	"reserved",
	"used",
}

AttributeState are the possible values that the attribute "state" can have.

var Attributes = struct {
	// Device (Identifier of the filesystem.)
	Device string
	// Mode (Mountpoint mode such "ro", "rw", etc.)
	Mode string
	// Mountpoint (Mountpoint path.)
	Mountpoint string
	// State (Breakdown of filesystem usage by type.)
	State string
	// Type (Filesystem type, such as, "ext4", "tmpfs", etc.)
	Type string
}{
	"device",
	"mode",
	"mountpoint",
	"state",
	"type",
}

Attributes contains the possible metric attributes that can be used.

var M = Metrics

M contains a set of methods for each metric that help with manipulating those metrics. M is an alias for Metrics

var Metrics = &metricStruct{
	&metricImpl{
		"system.filesystem.inodes.usage",
		func(metric pdata.Metric) {
			metric.SetName("system.filesystem.inodes.usage")
			metric.SetDescription("FileSystem inodes used.")
			metric.SetUnit("{inodes}")
			metric.SetDataType(pdata.MetricDataTypeSum)
			metric.Sum().SetIsMonotonic(false)
			metric.Sum().SetAggregationTemporality(pdata.MetricAggregationTemporalityCumulative)
		},
	},
	&metricImpl{
		"system.filesystem.usage",
		func(metric pdata.Metric) {
			metric.SetName("system.filesystem.usage")
			metric.SetDescription("Filesystem bytes used.")
			metric.SetUnit("By")
			metric.SetDataType(pdata.MetricDataTypeSum)
			metric.Sum().SetIsMonotonic(false)
			metric.Sum().SetAggregationTemporality(pdata.MetricAggregationTemporalityCumulative)
		},
	},
}

Metrics contains a set of methods for each metric that help with manipulating those metrics.

Types

type MetricIntf

type MetricIntf interface {
	Name() string
	New() pdata.Metric
	Init(metric pdata.Metric)
}

MetricIntf is an interface to generically interact with generated metric.