Host metrics
Collect metric data from the local system
Warnings
Failed to load partition usage data. mount_point="/host/proc/sys/fs/binfmt_misc" error=FFI function "statvfs" call failed: Too many levels of symbolic links (os error 40)
To work around this configuration issue, add one of the following lines to the
host_metrics
configuration section:
filesystem.devices.excludes = ["binfmt_misc"]
,
filesystem.filesystems.excludes = ["binfmt_misc"]
, or
filesystem.mountpoints.excludes = ["*/proc/sys/fs/binfmt_misc"]
.
This workaround is included by default in the Helm chart distributed with Vector.Configuration
Example configurations
{
"sources": {
"my_source_id": {
"type": "host_metrics"
}
}
}
[sources.my_source_id]
type = "host_metrics"
sources:
my_source_id:
type: host_metrics
{
"sources": {
"my_source_id": {
"type": "host_metrics",
"collectors": [
"cgroups"
],
"namespace": "host",
"scrape_interval_secs": 15
}
}
}
[sources.my_source_id]
type = "host_metrics"
collectors = [ "cgroups" ]
namespace = "host"
scrape_interval_secs = 15
sources:
my_source_id:
type: host_metrics
collectors:
- cgroups
namespace: host
scrape_interval_secs: 15
cgroups
optional objectOptions for the cgroups (controller groups) metrics collector.
This collector is only available on Linux systems, and only supports either version 2 or hybrid cgroups.
cgroups.base
optional string literalcgroups.groups
optional objectcgroups.groups.excludes
optional [string]Any patterns which should be excluded.
The patterns are matched using globbing.
cgroups.groups.includes
optional [string]Any patterns which should be included.
The patterns are matched using globbing.
[*]
cgroups.levels
optional uintThe number of levels of the cgroups hierarchy for which to report metrics.
A value of 1
means the root or named cgroup.
100
collectors
optional [string]The list of host metric collector services to use.
Defaults to all collectors.
[cpu disk filesystem load host memory network process cgroups]
disk
optional objectdisk.devices
optional objectdisk.devices.excludes
optional [string]Any patterns which should be excluded.
The patterns are matched using globbing.
disk.devices.includes
optional [string]Any patterns which should be included.
The patterns are matched using globbing.
[*]
filesystem
optional objectfilesystem.devices
optional objectfilesystem.devices.excludes
optional [string]Any patterns which should be excluded.
The patterns are matched using globbing.
filesystem.devices.includes
optional [string]Any patterns which should be included.
The patterns are matched using globbing.
[*]
filesystem.filesystems
optional objectfilesystem.filesystems.excludes
optional [string]Any patterns which should be excluded.
The patterns are matched using globbing.
filesystem.filesystems.includes
optional [string]Any patterns which should be included.
The patterns are matched using globbing.
[*]
filesystem.mountpoints
optional objectfilesystem.mountpoints.excludes
optional [string]Any patterns which should be excluded.
The patterns are matched using globbing.
filesystem.mountpoints.includes
optional [string]Any patterns which should be included.
The patterns are matched using globbing.
[*]
namespace
optional string literalhost
network
optional objectnetwork.devices
optional objectnetwork.devices.excludes
optional [string]Any patterns which should be excluded.
The patterns are matched using globbing.
network.devices.includes
optional [string]Any patterns which should be included.
The patterns are matched using globbing.
[*]
process
optional objectprocess.processes
optional objectprocess.processes.excludes
optional [string]Any patterns which should be excluded.
The patterns are matched using globbing.
process.processes.includes
optional [string]Any patterns which should be included.
The patterns are matched using globbing.
[*]
scrape_interval_secs
optional uint15
(seconds)Environment variables
PROCFS_ROOT
common optional string literal/proc
by default.SYSFS_ROOT
common optional string literal/sys
by default.Outputs
<component_id>
Output Data
Metrics
boot_time
gaugecgroup_cpu_system_seconds_total
countercgroup_cpu_usage_seconds_total
countercgroup_cpu_user_seconds_total
countercgroup_memory_anon_bytes
gaugecgroup_memory_current_bytes
gaugecgroup_memory_file_bytes
gaugedisk_read_bytes_total
counterdisk_reads_completed_total
counterdisk_writes_completed_total
counterdisk_written_bytes_total
counterfilesystem_free_bytes
gaugefilesystem_total_bytes
gaugefilesystem_used_bytes
gaugefilesystem_used_ratio
gaugehost_cpu_seconds_total
counterload1
gaugeload15
gaugeload5
gaugememory_active_bytes
gaugememory_available_bytes
gaugememory_buffers_bytes
gaugememory_cached_bytes
gaugememory_free_bytes
gaugememory_inactive_bytes
gaugememory_shared_bytes
gaugememory_swap_free_bytes
gaugememory_swap_total_bytes
gaugememory_swap_used_bytes
gaugememory_swapped_in_bytes_total
countermemory_swapped_out_bytes_total
countermemory_total_bytes
gaugememory_used_bytes
gaugememory_wired_bytes
gaugenetwork_receive_bytes_total
gaugenetwork_receive_errs_total
gaugenetwork_receive_packets_total
gaugenetwork_transmit_bytes_total
gaugenetwork_transmit_errs_total
gaugenetwork_transmit_packets_drop_total
gaugenetwork_transmit_packets_total
gaugeprocess_cpu_usage
gaugeprocess_memory_usage
gaugeTelemetry
Metrics
linkcomponent_discarded_events_total
counterfilter
transform, or false if due to an error.component_errors_total
countercomponent_received_bytes_total
countercomponent_received_event_bytes_total
countercomponent_received_events_count
histogramA histogram of the number of events passed in each internal batch in Vector’s internal topology.
Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.