fs

Documentation

Overview

Provides Filesystem Stats

Index

• Constants
• type Context
• type DeviceInfo
• type DiskStats
• type Fs
• type FsInfo
  • func NewFsInfo(context Context) (FsInfo, error)
• type FsType
  • func (ft FsType) String() string
• type RealFsInfo
  • func (self *RealFsInfo) GetDeviceForLabel(label string) (string, error)
  • func (self *RealFsInfo) GetDirFsDevice(dir string) (*DeviceInfo, error)
  • func (self *RealFsInfo) GetDirUsage(dir string, timeout time.Duration) (uint64, error)
  • func (self *RealFsInfo) GetFsInfoForPath(mountSet map[string]struct{}) ([]Fs, error)
  • func (self *RealFsInfo) GetGlobalFsInfo() ([]Fs, error)
  • func (self *RealFsInfo) GetLabelsForDevice(device string) ([]string, error)
  • func (self *RealFsInfo) GetMountpointForDevice(dev string) (string, error)

Constants

const (
	LabelSystemRoot   = "root"
	LabelDockerImages = "docker-images"
)

Types

type Context

type Context struct {
	// docker root directory.
	DockerRoot string
	DockerInfo map[string]string
}

type DeviceInfo

type DeviceInfo struct {
	Device string
	Major  uint
	Minor  uint
}

type DiskStats

type DiskStats struct {
	ReadsCompleted  uint64
	ReadsMerged     uint64
	SectorsRead     uint64
	ReadTime        uint64
	WritesCompleted uint64
	WritesMerged    uint64
	SectorsWritten  uint64
	WriteTime       uint64
	IoInProgress    uint64
	IoTime          uint64
	WeightedIoTime  uint64
}

type Fs

type Fs struct {
	DeviceInfo
	Type       FsType
	Capacity   uint64
	Free       uint64
	Available  uint64
	Inodes     uint64
	InodesFree uint64
	DiskStats  DiskStats
}

type FsInfo

type FsInfo interface {
	// Returns capacity and free space, in bytes, of all the ext2, ext3, ext4 filesystems on the host.
	GetGlobalFsInfo() ([]Fs, error)

	// Returns capacity and free space, in bytes, of the set of mounts passed.
	GetFsInfoForPath(mountSet map[string]struct{}) ([]Fs, error)

	// Returns number of bytes occupied by 'dir'.
	GetDirUsage(dir string, timeout time.Duration) (uint64, error)

	// Returns the block device info of the filesystem on which 'dir' resides.
	GetDirFsDevice(dir string) (*DeviceInfo, error)

	// Returns the device name associated with a particular label.
	GetDeviceForLabel(label string) (string, error)

	// Returns all labels associated with a particular device name.
	GetLabelsForDevice(device string) ([]string, error)

	// Returns the mountpoint associated with a particular device.
	GetMountpointForDevice(device string) (string, error)
}

func NewFsInfo

func NewFsInfo(context Context) (FsInfo, error)

type FsType

type FsType string

const (
	ZFS          FsType = "zfs"
	DeviceMapper FsType = "devicemapper"
	VFS          FsType = "vfs"
)

func (FsType) String

func (ft FsType) String() string

type RealFsInfo

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

func (*RealFsInfo) GetDeviceForLabel

func (self *RealFsInfo) GetDeviceForLabel(label string) (string, error)

func (*RealFsInfo) GetDirFsDevice

func (self *RealFsInfo) GetDirFsDevice(dir string) (*DeviceInfo, error)

func (*RealFsInfo) GetDirUsage

func (self *RealFsInfo) GetDirUsage(dir string, timeout time.Duration) (uint64, error)

func (*RealFsInfo) GetFsInfoForPath

func (self *RealFsInfo) GetFsInfoForPath(mountSet map[string]struct{}) ([]Fs, error)

func (*RealFsInfo) GetGlobalFsInfo

func (self *RealFsInfo) GetGlobalFsInfo() ([]Fs, error)

func (*RealFsInfo) GetLabelsForDevice

func (self *RealFsInfo) GetLabelsForDevice(device string) ([]string, error)

func (*RealFsInfo) GetMountpointForDevice

func (self *RealFsInfo) GetMountpointForDevice(dev string) (string, error)