README
¶
Docker-Stats-Go
Package docker-stats-go provides the ability to get currently running Docker container statistics, including memory and CPU usage.
To get the statistics of running Docker containers, you can use the Current()
function:
stats, err := dsg.Current()
if err != nil {
panic(err)
}
for _, s := range stats {
fmt.Println(s.Container) // 9f2656020722
fmt.Println(s.Memory) // {Raw=221.7 MiB / 7.787 GiB, Percent=2.78%}
fmt.Println(s.CPU) // 99.79%
}
Alternatively, you can use the NewMonitor() function to receive a constant
stream of Docker container stats, available on the Monitor's Stream channel:
m := dsg.NewMonitor()
for res := range m.Stream {
if res.Error != nil {
panic(err)
}
for _, s := range res.Stats {
fmt.Println(s.Container) // 9f2656020722
}
}
Documentation
¶
Overview ¶
Package dockerstats provides the ability to get currently running Docker container statistics, including memory and CPU usage.
To get the statistics of running Docker containers, you can use the `Current()` function:
stats, err := dockerstats.Current()
if err != nil {
panic(err)
}
for _, s := range stats {
fmt.Println(s.Container) // 9f2656020722
fmt.Println(s.Memory) // {Raw=221.7 MiB / 7.787 GiB, Percent=2.78%}
fmt.Println(s.CPU) // 99.79%
}
Alternatively, you can use the `NewMonitor()` function to receive a constant stream of Docker container stats, available on the Monitor's `Stream` channel:
m := dockerstats.NewMonitor()
for res := range m.Stream {
if res.Error != nil {
panic(err)
}
for _, s := range res.Stats {
fmt.Println(s.Container) // 9f2656020722
}
}
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CliCommunicator ¶
CliCommunicator uses the Docker CLI to retrieve stats for currently running Docker containers.
func (CliCommunicator) Stats ¶
func (c CliCommunicator) Stats() ([]Stats, error)
Stats returns Docker container statistics using the Docker CLI.
type Communicator ¶
Communicator provides an interface for communicating with and retrieving stats from Docker.
var DefaultCommunicator Communicator = CliCommunicator{ DockerPath: defaultDockerPath, Command: []string{defaultDockerCommand, defaultDockerNoStreamArg, defaultDockerFormatArg, defaultDockerFormat}, }
DefaultCommunicator is the default way of retrieving stats from Docker.
When calling `Current()`, the `DefaultCommunicator` is used, and when retriving a `Monitor` using `NewMonitor()`, it is initialized with the `DefaultCommunicator`.
type IOStats ¶
IOStats contains the statistics of a running Docker container related to IO, including network and block.
type MemoryStats ¶
MemoryStats contains the statistics of a running Docker container related to memory usage.
func (MemoryStats) String ¶
func (m MemoryStats) String() string
String returns a human-readable string containing the details of a MemoryStats value.
type Monitor ¶
type Monitor struct {
Stream chan *StatsResult
Comm Communicator
// contains filtered or unexported fields
}
Monitor provides the ability to recieve a constant stream of statistics for each running Docker container.
Each `StatsResult` sent through the channel contains either an `error` or a `Stats` slice equal in length to the number of running Docker containers.
func NewMonitor ¶
func NewMonitor() *Monitor
NewMonitor initializes and returns a Monitor which can recieve a stream of Docker container statistics.
type Stats ¶
type Stats struct {
Container string `json:"container"`
Memory MemoryStats `json:"memory"`
CPU string `json:"cpu"`
IO IOStats `json:"io"`
PIDs int `json:"pids"`
}
Stats contains the statistics of a currently running Docker container.
type StatsResult ¶
StatsResult is the value recieved when using Monitor to listen for Docker statistics.
Source Files