Documentation
¶
Overview ¶
Package system is a Metricbeat module that contains MetricSets that collect system level information like CPU and memory stats.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
HostFS = flag.String("system.hostfs", "", "mountpoint of the host's filesystem for use in monitoring a host from within a container")
)
var ( // NumCPU is the number of CPU cores in the system. Changes to operating // system CPU allocation after process startup are not reflected. NumCPU = runtime.NumCPU() )
Functions ¶
Types ¶
type CPUCoreMetrics ¶
type CPUCoreMetrics CPUMetrics
CPUCoreMonitor is used to monitor the usage of individual CPU cores.
func (*CPUCoreMetrics) Percentages ¶
func (m *CPUCoreMetrics) Percentages() CPUPercentages
Percentages returns CPU percentage usage information for the core. The values range from [0, 100%].
func (*CPUCoreMetrics) Ticks ¶
func (m *CPUCoreMetrics) Ticks() CPUTicks
Ticks returns the raw number of "ticks". The value is a counter (though it may roll over).
type CPUCoresMonitor ¶
type CPUCoresMonitor struct {
// contains filtered or unexported fields
}
CPUCoresMonitor is used to monitor the usage information of all the CPU cores in the system.
func (*CPUCoresMonitor) Sample ¶
func (m *CPUCoresMonitor) Sample() ([]CPUCoreMetrics, error)
Sample collects a new sample of the metrics from all CPU cores.
type CPUMetrics ¶
type CPUMetrics struct {
// contains filtered or unexported fields
}
func (*CPUMetrics) NormalizedPercentages ¶
func (m *CPUMetrics) NormalizedPercentages() CPUPercentages
NormalizedPercentages returns CPU percentage usage information that is normalized by the number of CPU cores (NumCPU). The values will range from 0 to 100%.
func (*CPUMetrics) Percentages ¶
func (m *CPUMetrics) Percentages() CPUPercentages
Percentages returns CPU percentage usage information. The values range from 0 to 100% * NumCPU.
func (*CPUMetrics) Ticks ¶
func (m *CPUMetrics) Ticks() CPUTicks
type CPUMonitor ¶
type CPUMonitor struct {
// contains filtered or unexported fields
}
CPUMonitor is used to monitor the overal CPU usage of the system.
func (*CPUMonitor) Sample ¶
func (m *CPUMonitor) Sample() (*CPUMetrics, error)
Sample collects a new sample of the CPU usage metrics.
type CPUPercentages ¶
type LoadAverages ¶
type LoadMetrics ¶
type LoadMetrics struct {
// contains filtered or unexported fields
}
func Load ¶
func Load() (*LoadMetrics, error)
Load returns CPU load information for the previous 1, 5, and 15 minute periods.
func (*LoadMetrics) Averages ¶
func (m *LoadMetrics) Averages() LoadAverages
Averages return the CPU load averages. These values should range from 0 to NumCPU.
func (*LoadMetrics) NormalizedAverages ¶
func (m *LoadMetrics) NormalizedAverages() LoadAverages
NormalizedAverages return the CPU load averages normalized by the NumCPU. These values should range from 0 to 1.
type Module ¶
type Module struct {
mb.BaseModule
HostFS string // Mountpoint of the host's filesystem for use in monitoring inside a container.
}
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
_meta
|
|
|
Package core collects cpu core metrics from the host OS.
|
Package core collects cpu core metrics from the host OS. |
|
Package cpu collects CPU metrics from the host OS.
|
Package cpu collects CPU metrics from the host OS. |
|
Package diskio fetches disk IO metrics from the OS.
|
Package diskio fetches disk IO metrics from the OS. |
|
Package filesystem provides a MetricSet implementation that fetches metrics for each of the mounted file systems.
|
Package filesystem provides a MetricSet implementation that fetches metrics for each of the mounted file systems. |
|
Package fsstat provides a MetricSet for fetching aggregated filesystem stats.
|
Package fsstat provides a MetricSet for fetching aggregated filesystem stats. |
|
Package load collects system CPU load metrics from the host OS.
|
Package load collects system CPU load metrics from the host OS. |
|
Package memory collects memory metrics from the host OS.
|
Package memory collects memory metrics from the host OS. |
|
Package network provides network IO metrics from the OS.
|
Package network provides network IO metrics from the OS. |
|
Package process collects metrics about the running processes using information from the operating system.
|
Package process collects metrics about the running processes using information from the operating system. |
|
Package process_summary collects high level summary metrics about the running processes.
|
Package process_summary collects high level summary metrics about the running processes. |
|
Package socket captures active sockets and the processes that own them.
|
Package socket captures active sockets and the processes that own them. |
|
Package uptime reports the system's uptime.
|
Package uptime reports the system's uptime. |