Sensu CPU usage check

Table of Contents

• Overview
• Usage examples
• Configuration
  • Asset registration
  • Check definition
• Installation from source
• Contributing

Overview

The Sensu CPU usage check is a Sensu Check that provides alerting and metrics for CPU usage. Metrics are provided in nagios_perfdata format.

Note: The macOS binary is built using cgo and may not be portable across all versions of macOS.

Usage examples

Check CPU usage and provide metrics

Usage:
  check-cpu-usage [flags]
  check-cpu-usage [command]

Available Commands:
  help        Help about any command
  version     Print the version number of this plugin

Flags:
  -c, --critical float        Critical threshold for overall CPU usage (default 90)
  -h, --help                  help for check-cpu-usage
  -s, --sample-interval int   Length of sample interval in seconds (default 2)
      --usage-type string     Check cpu usage of type: [Total User System Idle Nice Iowait Irq Softirq Steal Guest GuestNice] (default "Total")
      --usage-types string    Check cpu usage multiple type, see usage-type. list comma seperated format per value: 'type:warning:critical:invert'. Type is required, rest uses the defaults
  -w, --warning float         Warning threshold for overall CPU usage (default 75)

Use "check-cpu-usage [command] --help" for more information about a command.

List of types and OS support:

• All: Total User System Idle
• Mac + Linux : Nice
• Linux: Iowait Irq Softirq Steal Guest GuestNice

If using an unsupported type it will return 0.

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/check-cpu-usage

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: check-cpu-usage
  namespace: default
spec:
  command: >-
    check-cpu-usage
    --critical 95
    --warning 85
    --sample-interval 2
    --usage-types User:90:95,Steal:10:20
  output_metric_format: nagios_perfdata
  output_metric_handlers:
    - influxdb
  subscriptions:
  - system
  runtime_assets:
  - sensu/check-cpu-usage

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 from this source.

From the local path of the check-cpu-usage repository:

go build

Contributing

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