network-interface-checks

Sensu Network Interface Checks

Table of Contents

• Overview
  • Output Metrics
  • Rate Metrics
• Usage examples
  • Help output
  • Environment variables
• Configuration
  • Asset registration
  • Check definition
• Installation from source
• Additional notes
• Contributing

Overview

The Sensu Network Interface Checks are Linux Sensu Metrics Check that provides baseline network metrics in prometheus format.

Output Metrics

Rate Metrics

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.

Usage examples

Help output

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
      --sumologic-compat             Add Sumo Logic compatible metrics with w/ "host_net" family

Use "network-interface-checks [command] --help" for more information about a command.

Environment variables

Configuration

Asset registration

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.

Check definition

---
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

Installation from source

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

Additional notes

This plugin is only supported on Linux.

Contributing

For more information about contributing to this plugin, see Contributing.