storage

Documentation

Index

• type StorageDriver

Types

type StorageDriver

type StorageDriver interface {
	AddStats(ref info.ContainerReference, stats *info.ContainerStats) error

	// Read most recent stats. numStats indicates max number of stats
	// returned. The returned stats must be consecutive observed stats. If
	// numStats < 0, then return all stats stored in the storage. The
	// returned stats should be sorted in time increasing order, i.e. Most
	// recent stats should be the last.
	RecentStats(containerName string, numStats int) ([]*info.ContainerStats, error)

	// Read the specified percentiles of CPU and memory usage of the container.
	// The implementation decides which time range to look at.
	Percentiles(containerName string, cpuUsagePercentiles []int, memUsagePercentiles []int) (*info.ContainerStatsPercentiles, error)

	// Returns samples of the container stats. If numSamples < 0, then
	// the number of returned samples is implementation defined. Otherwise, the driver
	// should return at most numSamples samples.
	Samples(containerName string, numSamples int) ([]*info.ContainerStatsSample, error)

	// Close will clear the state of the storage driver. The elements
	// stored in the underlying storage may or may not be deleted depending
	// on the implementation of the storage driver.
	Close() error
}