Host Metrics

CAUTION

When vector is run under kubernetes, you may experience an error when loading the partition usage data: 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 Options

Required Options

type(required)

The component type. This is a required field for all components and tells Vector which component to use.

TypeSyntaxDefaultExample
stringliteral["host_metrics"]

Advanced Options

collectors(optional)

The list of host metric collector services to use. Defaults to all collectors.

TypeSyntaxDefaultExample
arrayliteralcgroupscpudiskfilesystemloadhostmemorynetwork["cgroups","cpu","disk","filesystem","load","host","memory","network"]
namespace(optional)

The namespace of metrics. Disabled if empty.

TypeSyntaxDefaultExample
stringliteralhost
scrape_interval_secs(optional)

The interval between metric gathering, in seconds.

TypeSyntaxDefaultExample
uint15
cgroups(optional)

Options for the "cgroups" (controller groups) metrics collector.

Note: this collector is only available on Linux systems, and only supports either version 2 or hybrid cgroups.

TypeSyntaxDefaultExample
hashliteral[]
disk(optional)

Options for the "disk" metrics collector.

TypeSyntaxDefaultExample
hashliteral[]
filesystem(optional)

Options for the "filesystem" metrics collector.

TypeSyntaxDefaultExample
hashliteral[]
network(optional)

Options for the "network" metrics collector.

TypeSyntaxDefaultExample
hashliteral[]

How it Works

State

This component is stateless, meaning its behavior is consistent across each input.

Context

By default, the host_metrics source augments events with helpful context keys.