xfs

package
v0.21.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 27, 2026 License: Apache-2.0 Imports: 8 Imported by: 54

Documentation

Overview

Package xfs provides access to statistics exposed by the XFS filesystem.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttributeOperationStats 

type AttributeOperationStats struct {
	Get    uint32
	Set    uint32
	Remove uint32
	List   uint32
}

AttributeOperationStats contains statistics regarding manipulation of XFS extended file attributes.

type BTreeStats 

type BTreeStats struct {
	Lookups         uint32
	Compares        uint32
	RecordsInserted uint32
	RecordsDeleted  uint32
}

BTreeStats contains statistics regarding an XFS internal B-tree.

type BlockMappingStats 

type BlockMappingStats struct {
	Reads                uint32
	Writes               uint32
	Unmaps               uint32
	ExtentListInsertions uint32
	ExtentListDeletions  uint32
	ExtentListLookups    uint32
	ExtentListCompares   uint32
}

BlockMappingStats contains statistics regarding XFS block maps.

type BtreeAllocBlocks2Stats added in v0.0.4 

type BtreeAllocBlocks2Stats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeAllocBlocks2Stats contains statistics on B-Tree v2 allocations.

type BtreeAllocContig2Stats added in v0.0.4 

type BtreeAllocContig2Stats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeAllocContig2Stats contain statistics on B-tree v2 free-space-by-size record operations.

type BtreeBlockMap2Stats added in v0.0.4 

type BtreeBlockMap2Stats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeBlockMap2Stats contain statistics on B-tree v2 block map operations.

type BtreeFreeInode2Stats added in v0.21.0 

type BtreeFreeInode2Stats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeFreeInode2Stats contain statistics on B-tree v2 free inode allocations.

type BtreeInode2Stats added in v0.0.4 

type BtreeInode2Stats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeInode2Stats contain statistics on B-tree v2 inode allocations.

type BtreeRcbagStats added in v0.21.0 

type BtreeRcbagStats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeRcbagStats contain statistics on B-tree rcbag record operations.

type BtreeRefCountStats added in v0.21.0 

type BtreeRefCountStats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeRefCountStats contain statistics on B-tree reference count record operations.

type BtreeReverseMapMemStats added in v0.21.0 

type BtreeReverseMapMemStats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeReverseMapMemStats contain statistics on B-tree reverse mapping in-memory record operations.

type BtreeReverseMapStats added in v0.21.0 

type BtreeReverseMapStats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeReverseMapStats contain statistics on B-tree reverse mapping record operations.

type BtreeRtRefCountStats added in v0.21.0 

type BtreeRtRefCountStats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeRtRefCountStats contain statistics on B-tree realtime reference count record operations.

type BtreeRtReverseMapMemStats added in v0.21.0 

type BtreeRtReverseMapMemStats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeRtReverseMapMemStats contain statistics on B-tree realtime reverse mapping in-memory record operations.

type BtreeRtReverseMapStats added in v0.21.0 

type BtreeRtReverseMapStats struct {
	Lookup    uint32
	Compare   uint32
	Insrec    uint32
	Delrec    uint32
	NewRoot   uint32
	KillRoot  uint32
	Increment uint32
	Decrement uint32
	Lshift    uint32
	Rshift    uint32
	Split     uint32
	Join      uint32
	Alloc     uint32
	Free      uint32
	Moves     uint32
}

BtreeRtReverseMapStats contain statistics on B-tree realtime reverse mapping record operations.

type BufferStats 

type BufferStats struct {
	Get             uint32
	Create          uint32
	GetLocked       uint32
	GetLockedWaited uint32
	BusyLocked      uint32
	MissLocked      uint32
	PageRetries     uint32
	PageFound       uint32
	GetRead         uint32
}

BufferStats contains statistics regarding XFS read/write I/O buffers.

type DebugStats added in v0.0.4 

type DebugStats struct {
	Enabled uint32
}

DebugStats indicate if XFS debugging is enabled.

type DeferRelogStats added in v0.21.0 

type DeferRelogStats struct {
	Count uint64
}

DeferRelogStats contains the deferred buffer relog count.

type DirectoryOperationStats 

type DirectoryOperationStats struct {
	Lookups  uint32
	Creates  uint32
	Removes  uint32
	Getdents uint32
}

DirectoryOperationStats contains statistics regarding XFS directory entries.

type ExtendedPrecisionStats 

type ExtendedPrecisionStats struct {
	FlushBytes uint64
	WriteBytes uint64
	ReadBytes  uint64
}

ExtendedPrecisionStats contains high precision counters used to track the total number of bytes read, written, or flushed, during XFS operations.

type ExtentAllocationStats 

type ExtentAllocationStats struct {
	ExtentsAllocated uint32
	BlocksAllocated  uint32
	ExtentsFreed     uint32
	BlocksFreed      uint32
}

ExtentAllocationStats contains statistics regarding XFS extent allocations.

type FS 

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

FS represents the pseudo-filesystems proc and sys, which provides an interface to kernel data structures.

func NewDefaultFS added in v0.0.2 

func NewDefaultFS() (FS, error)

NewDefaultFS returns a new XFS handle using the default proc and sys mountPoints. It will error if either of the mounts point can't be read.

func NewFS 

func NewFS(procMountPoint string, sysMountPoint string) (FS, error)

NewFS returns a new XFS handle using the given proc and sys mountPoints. It will error if either of the mounts point can't be read.

func (FS) ProcStat 

func (fs FS) ProcStat() (*Stats, error)

ProcStat retrieves XFS filesystem runtime statistics from proc/fs/xfs/stat given the profs mount point.

func (FS) SysStats 

func (fs FS) SysStats() ([]*Stats, error)

SysStats retrieves XFS filesystem runtime statistics for each mounted XFS filesystem. Only available on kernel 4.4+. On older kernels, an empty slice of *xfs.Stats will be returned.

type GcXpcStats added in v0.21.0 

type GcXpcStats struct {
	Bytes uint64
}

GcXpcStats contains extended precision bytes for garbage collection.

type InodeClusteringStats 

type InodeClusteringStats struct {
	Iflush     uint32
	Flush      uint32
	FlushInode uint32
}

InodeClusteringStats contains statistics regarding XFS inode clustering operations.

type InodeOperationStats 

type InodeOperationStats struct {
	Attempts        uint32
	Found           uint32
	Recycle         uint32
	Missed          uint32
	Duplicate       uint32
	Reclaims        uint32
	AttributeChange uint32
}

InodeOperationStats contains statistics regarding XFS inode operations.

type LogOperationStats 

type LogOperationStats struct {
	Writes            uint32
	Blocks            uint32
	NoInternalBuffers uint32
	Force             uint32
	ForceSleep        uint32
}

LogOperationStats contains statistics regarding the XFS log buffer.

type MetaFileStats added in v0.21.0 

type MetaFileStats struct {
	Inodes uint32
}

MetaFileStats contain statistics on metafile inode operations.

type PushAilStats added in v0.0.4 

type PushAilStats struct {
	TryLogspace   uint32
	SleepLogspace uint32
	Pushes        uint32
	Success       uint32
	PushBuf       uint32
	Pinned        uint32
	Locked        uint32
	Flushing      uint32
	Restarts      uint32
	Flush         uint32
}

PushAilStats contains statistics on tail-pushing operations.

type QuotaManagerStats added in v0.0.4 

type QuotaManagerStats struct {
	Reclaims      uint32
	ReclaimMisses uint32
	DquoteDups    uint32
	CacheMisses   uint32
	CacheHits     uint32
	Wants         uint32
	ShakeReclaims uint32
	InactReclaims uint32
	Unused        uint32
}

QuotaManagerStats contain statistics regarding quota processing.

type ReadWriteStats 

type ReadWriteStats struct {
	Write uint32
	Read  uint32
}

ReadWriteStats contains statistics regarding the number of read and write system calls for XFS filesystems.

type Stats 

type Stats struct {
	// The name of the filesystem used to source these statistics.
	// If empty, this indicates aggregated statistics for all XFS
	// filesystems on the host.
	Name string

	ExtentAllocation     ExtentAllocationStats     // extent_alloc
	AllocationBTree      BTreeStats                // abt
	BlockMapping         BlockMappingStats         // blk_map
	BlockMapBTree        BTreeStats                // bmbt
	DirectoryOperation   DirectoryOperationStats   // dir
	Transaction          TransactionStats          // trans
	InodeOperation       InodeOperationStats       // ig
	LogOperation         LogOperationStats         // log
	ReadWrite            ReadWriteStats            // rw
	AttributeOperation   AttributeOperationStats   // attr
	InodeClustering      InodeClusteringStats      // icluster
	Vnode                VnodeStats                // vnodes
	Buffer               BufferStats               // buf
	ExtendedPrecision    ExtendedPrecisionStats    // xpc
	Xstrat               XstratStats               // xstrat
	PushAil              PushAilStats              // push_ail
	Debug                DebugStats                // debug
	QuotaManager         QuotaManagerStats         // qm
	BtreeAllocBlocks2    BtreeAllocBlocks2Stats    // abtb2
	BtreeAllocContig2    BtreeAllocContig2Stats    // abtc2
	BtreeBlockMap2       BtreeBlockMap2Stats       // bmbt2
	BtreeInode2          BtreeInode2Stats          // ibt2
	BtreeFreeInode2      BtreeFreeInode2Stats      // fibt2
	BtreeReverseMap      BtreeReverseMapStats      // rmapbt
	BtreeRefCount        BtreeRefCountStats        // refcntbt
	BtreeReverseMapMem   BtreeReverseMapMemStats   // rmapbt_mem
	BtreeRcbag           BtreeRcbagStats           // rcbagbt
	BtreeRtReverseMap    BtreeRtReverseMapStats    // rtrmapbt
	BtreeRtReverseMapMem BtreeRtReverseMapMemStats // rtrmapbt_mem
	BtreeRtRefCount      BtreeRtRefCountStats      // rtrefcntbt
	Zoned                ZonedStats                // zoned
	MetaFile             MetaFileStats             // metafile
	DeferRelog           DeferRelogStats           // defer_relog
	GcXpc                GcXpcStats                // gc xpc
}

Stats contains XFS filesystem runtime statistics, parsed from /proc/fs/xfs/stat.

The names and meanings of each statistic were taken from http://xfs.org/index.php/Runtime_Stats and xfs_stats.h in the Linux kernel source. Most counters are uint32s (same data types used in xfs_stats.h), but some of the "extended precision stats" are uint64s.

func ParseStats 

func ParseStats(r io.Reader) (*Stats, error)

ParseStats parses a Stats from an input io.Reader, using the format found in /proc/fs/xfs/stat.

type TransactionStats 

type TransactionStats struct {
	Sync  uint32
	Async uint32
	Empty uint32
}

TransactionStats contains statistics regarding XFS metadata transactions.

type VnodeStats 

type VnodeStats struct {
	Active   uint32
	Allocate uint32
	Get      uint32
	Hold     uint32
	Release  uint32
	Reclaim  uint32
	Remove   uint32
	Free     uint32
}

VnodeStats contains statistics regarding XFS vnode operations.

type XstratStats added in v0.0.4 

type XstratStats struct {
	Quick uint32
	Split uint32
}

XstratStats contains statistics regarding bytes processed by the XFS daemon.

type ZonedStats added in v0.21.0 

type ZonedStats struct {
	GcReadCalls      uint32
	GcWriteCalls     uint32
	GcZoneResetCalls uint32
}

ZonedStats contain statistics on zoned garbage collection operations.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.