metrics

Documentation

Index

• type ContainerCPUStats
• type ContainerIOStats
• type ContainerLimits
• type ContainerMemStats
• type ContainerMetrics
• type ContainerMetricsProvider
• type ContainerNetStats
  • func (ns ContainerNetStats) SumInterfaces() *InterfaceNetStats
• type InterfaceNetStats

Types

type ContainerCPUStats

type ContainerCPUStats struct {
	Timestsamp time.Time

	// docker.cpu.system
	System uint64

	// docker.cpu.user
	User uint64

	// docker.cpu.usage
	UsageTotal float64

	SystemUsage uint64

	// docker.cpu.shares
	Shares uint64

	// docker.cpu.throttled
	NrThrottled   uint64
	ThrottledTime float64

	// docker.thread.count
	ThreadCount uint64
}

ContainerCPUStats stores CPU times for a cgroup. Unit is userspace scheduling unit (USER_HZ, usually 1/100)

type ContainerIOStats

type ContainerIOStats struct {
	// docker.io.read_bytes
	ReadBytes uint64

	// docker.io.write_bytes
	WriteBytes uint64

	// docker.io.read_bytes
	DeviceReadBytes map[string]uint64

	// docker.io.write_bytes
	DeviceWriteBytes map[string]uint64

	// docker.container.open_fds
	OpenFiles uint64
}

ContainerIOStats store I/O statistics about a cgroup. Sums are stored in ReadBytes and WriteBytes

type ContainerLimits

type ContainerLimits struct {
	CPULimit    float64
	MemLimit    uint64
	ThreadLimit uint64
}

ContainerLimits represents the (normally static) resources limits set when a container is created

type ContainerMemStats

type ContainerMemStats struct {
	// docker.mem.cache
	Cache uint64

	// docker.mem.swap
	Swap        uint64 // See SwapPresent to make sure it's a real zero
	SwapPresent bool

	// docker.mem.rss
	RSS uint64

	RSSHuge      uint64
	MappedFile   uint64
	Pgpgin       uint64
	Pgpgout      uint64
	Pgfault      uint64
	Pgmajfault   uint64
	InactiveAnon uint64
	ActiveAnon   uint64
	InactiveFile uint64
	ActiveFile   uint64
	Unevictable  uint64

	// docker.mem.limit
	// Note: docker.mem.in_use = docker.mem.rss / docker.mem.limit
	HierarchicalMemoryLimit uint64

	// docker.mem.sw_limit
	// Note: docker.mem.sw_in_use = docker.mem.rss / docker.mem.sw_limit
	HierarchicalMemSWLimit uint64 // One can safely assume 0 == absent

	TotalCache        uint64
	TotalRSS          uint64
	TotalRSSHuge      uint64
	TotalMappedFile   uint64
	TotalPgpgIn       uint64
	TotalPgpgOut      uint64
	TotalPgFault      uint64
	TotalPgMajFault   uint64
	TotalInactiveAnon uint64
	TotalActiveAnon   uint64
	TotalInactiveFile uint64
	TotalActiveFile   uint64
	TotalUnevictable  uint64
	MemUsageInBytes   uint64

	// docker.mem.soft_limit
	SoftMemLimit uint64

	// docker.kmem.usage
	KernMemUsage uint64

	// docker.mem.failed_count
	MemFailCnt uint64

	// docker.mem.private_working_set
	PrivateWorkingSet uint64

	// docker.mem.commit_bytes
	CommitBytes uint64

	// docker.mem.commit_peak_bytes
	CommitPeakBytes uint64
}

ContainerMemStats stores memory statistics about a cgroup.

type ContainerMetrics

type ContainerMetrics struct {
	CPU    *ContainerCPUStats
	Memory *ContainerMemStats
	IO     *ContainerIOStats
}

ContainerMetrics wraps all container metrics

type ContainerMetricsProvider

type ContainerMetricsProvider interface {
	GetContainerMetrics(containerID string) (*ContainerMetrics, error)
	GetContainerLimits(containerID string) (*ContainerLimits, error)
	GetNetworkMetrics(containerID string, networks map[string]string) (ContainerNetStats, error)
}

ContainerMetricsProvider defines the API for any implementation that could provide container metrics

type ContainerNetStats

type ContainerNetStats []*InterfaceNetStats

ContainerNetStats stores network statistics about a Docker container per interface

func (ContainerNetStats) SumInterfaces

func (ns ContainerNetStats) SumInterfaces() *InterfaceNetStats

SumInterfaces sums stats from all interfaces into a single InterfaceNetStats

type InterfaceNetStats

type InterfaceNetStats struct {
	NetworkName string
	BytesSent   uint64
	BytesRcvd   uint64
	PacketsSent uint64
	PacketsRcvd uint64
}

InterfaceNetStats stores network statistics about a Docker network interface