diskstatsreader

Documentation

Overview

Package diskstatsreader provides functionality for collecting OS disk metrics.

Index

• type FileReader
• type Reader
  • func New(os string, fileReader FileReader, execute commandlineexecutor.Execute) *Reader
  • func (r *Reader) Read(ip *iipb.InstanceProperties) *statspb.DiskStatsCollection

Types

type FileReader

type FileReader func(string) ([]byte, error)

FileReader is a function type matching the signature for os.ReadFile.

type Reader

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

A Reader is capable of reading disk statistics from the OS.

Due to the assignment of required unexported fields, a Reader must be initialized with New() instead of as a struct literal.

func New

func New(os string, fileReader FileReader, execute commandlineexecutor.Execute) *Reader

New instantiates a Reader with the capability to read disk metrics from linux and windows operating systems.

func (*Reader) Read

func (r *Reader) Read(ip *iipb.InstanceProperties) *statspb.DiskStatsCollection

Read reads disk metrics from the OS and returns a collection of disk stats by device mapping.