License
Unknown
v0.1.0 · public · Published almost 3 years ago
The Sensu Network Interface Checks are Linux Sensu Metrics Check that provides baseline network metrics in prometheus format.
Name | Type | Description |
---|---|---|
bytes_sent | counter | Bytes sent |
bytes_sent_rate | gauge | Bytes sent per second |
bytes_recv | counter | Bytes received |
bytes_recv_rate | gauge | Bytes received per second |
packets_sent | counter | Packets sent |
packets_sent_rate | gauge | Packets sent per second |
packets_recv | counter | Packets received |
packets_recv_rate | gauge | Packets received per second |
err_out | counter | Outbound errors |
err_out_rate | gauge | Outbound errors per second |
err_in | counter | Inbound errors |
err_in_rate | gauge | Inbound errors per second |
drop_out | counter | Outbound packets dropped |
drop_out_rate | gauge | Outbound packets dropped per second |
drop_in | counter | Inbound packets dropped |
drop_in_rate | gauge | Inbound packets dropped per second |
In order to obtain rate metrics the --state-file
argument must be used. The state file holds previous values and millisecond accurate timestamp, which are used to calculate metric rate using a simple time difference between current values and previously recorded values in the state file. By default rate metrics are only calculated if the stored values in the selected state file are less than 60 seconds old. You can optionally set the maximum allowed time interval using --max-rate-interval
if the 60 second default isn't suitable.
If the state file does not exist or if the state is too stale, the rate metrics will not be produced.
Network Interface Checks
Usage:
network-interface-checks [flags]
network-interface-checks [command]
Available Commands:
completion generate the autocompletion script for the specified shell
help Help about any command
version Print the version number of this plugin
Flags:
-x, --exclude-interfaces strings Comma-delimited string of interface names to exclude (default [lo])
-h, --help help for network-interface-checks
-i, --include-interfaces strings Comma-delimited string of interface names to include
-r, --max-rate-interval int Maximum number of seconds since last measurement that triggers a rate calculation. 0 for no maximum. (default 60)
-f, --state-file string State file used for rate calculation. If empty no rate is calculated.
-s, --sum Add additional measurement per metric w/ "interface=all" tag
Use "network-interface-checks [command] --help" for more information about a command.
Argument | Environment Variable |
---|---|
--sum | NETWORK_INTERFACE_CHECKS_SUM |
--include-interfaces | NETWORK_INTERFACE_CHECKS_INCLUDE_INTERFACES |
--exclude-interfaces | NETWORK_INTERFACE_CHECKS_EXCLUDE_INTERFACES |
--max-rate-interval | NETWORK_INTERFACE_CHECKS_MAX_RATE_INTERVAL |
--state-file | NETWORK_INTERFACE_CHECKS_STATE_FILE |
Sensu Assets are the best way to make use of this plugin. If you're not using an asset, please
consider doing so! If you're using sensuctl 5.13 with Sensu Backend 5.13 or later, you can use the
following command to add the asset:
sensuctl asset add sensu/network-interface-checks
If you're using an earlier version of sensuctl, you can find the asset on the Bonsai Asset Index.
---
type: CheckConfig
api_version: core/v2
metadata:
name: network-interface-checks
namespace: default
spec:
command: network-interface-checks
subscriptions:
- system
runtime_assets:
- sensu/network-interface-checks
The preferred way of installing and deploying this plugin is to use it as an Asset. If you would
like to compile and install the plugin from source or contribute to it, download the latest version
or create an executable script from this source.
From the local path of the network-interface-checks repository:
go build
This plugin is only supported on Linux.
For more information about contributing to this plugin, see Contributing.
Please describe the reason for reporting this asset. Our moderators will be notified and will disable the asset if it is found to be inappropriate.
×