filesystem

Documentation

Overview

Package filesystem returns information about available filesystems.

Index

• Variables
• type FileSystem
  • func (fs *FileSystem) Collect() (interface{}, error)
  • func (fs *FileSystem) Name() string
• type MountInfo
  • func Get() ([]MountInfo, error)

Variables

var (

	// ErrTimeoutExceeded represents a timeout error
	ErrTimeoutExceeded = errors.New("timeout exceeded")
)

Types

type FileSystem

type FileSystem struct{}

FileSystem implements the Collector interface, providing information about mounted filesystems.

func (*FileSystem) Collect

func (fs *FileSystem) Collect() (interface{}, error)

Collect returns the list of mounted filesystems as an object which can be used to generate a JSON

func (*FileSystem) Name

func (fs *FileSystem) Name() string

Name returns the name of the package

type MountInfo

type MountInfo struct {
	// Name is the name of the mounted filesystem.
	Name string `json:"name"`
	// SizeKB is the size of the mounted filesystem in KB.
	SizeKB uint64 `json:"kb_size"`
	// MountedOn is the mount point path of the mounted filesystem.
	MountedOn string `json:"mounted_on"`
}

MountInfo represents a mounted filesystem.

func Get

func Get() ([]MountInfo, error)

Get returns the list of mounted filesystems