metrics

Documentation

Index

• Variables
• func InitializeNVME(r *metricRecorder, csiMountPointPath, instanceID string)
• func InitializeRecorder() *metricRecorder
• func Recorder() *metricRecorder
• type BlockDevice
• type EBSMetrics
• type Histogram
• type HistogramBin
• type LsblkOutput
• type NVMECollector
  • func NewNVMECollector(path, instanceID string) *NVMECollector
  • func (c *NVMECollector) Collect(ch chan<- prometheus.Metric)
  • func (c *NVMECollector) Describe(ch chan<- *prometheus.Desc)

Variables

var (
	ErrInvalidEBSMagic = errors.New("invalid EBS magic number")
	ErrParseLogPage    = errors.New("failed to parse log page")
)

Functions

func InitializeNVME

func InitializeNVME(r *metricRecorder, csiMountPointPath, instanceID string)

InitializeNVME registers the NVMe collector for gathering metrics from NVMe devices.

func InitializeRecorder

func InitializeRecorder() *metricRecorder

InitializeRecorder initializes a new metricRecorder instance if it hasn't been initialized.

func Recorder

func Recorder() *metricRecorder

Recorder returns the singleton instance of metricRecorder. nil is returned if the recorder is not initialized.

Types

type BlockDevice

type BlockDevice struct {
	Name   string `json:"name"`
	Serial string `json:"serial"`
}

type EBSMetrics

type EBSMetrics struct {
	EBSMagic              uint64
	ReadOps               uint64
	WriteOps              uint64
	ReadBytes             uint64
	WriteBytes            uint64
	TotalReadTime         uint64
	TotalWriteTime        uint64
	EBSIOPSExceeded       uint64
	EBSThroughputExceeded uint64
	EC2IOPSExceeded       uint64
	EC2ThroughputExceeded uint64
	QueueLength           uint64
	ReservedArea          [416]byte
	ReadLatency           Histogram
	WriteLatency          Histogram
}

EBSMetrics represents the parsed metrics from the NVMe log page.

type Histogram

type Histogram struct {
	BinCount uint64
	Bins     [64]HistogramBin
}

type HistogramBin

type HistogramBin struct {
	Lower uint64
	Upper uint64
	Count uint64
}

type LsblkOutput

type LsblkOutput struct {
	BlockDevices []BlockDevice `json:"blockdevices"`
}

type NVMECollector

type NVMECollector struct {
	// contains filtered or unexported fields
}

func NewNVMECollector

func NewNVMECollector(path, instanceID string) *NVMECollector

NewNVMECollector creates a new instance of NVMECollector.

func (*NVMECollector) Collect

func (c *NVMECollector) Collect(ch chan<- prometheus.Metric)

Collect is invoked by Prometheus at collection time.

func (*NVMECollector) Describe

func (c *NVMECollector) Describe(ch chan<- *prometheus.Desc)

Describe sends the descriptor of each metric in the NVMECollector to Prometheus.