Sensu System Check

Table of Contents

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

Overview

The Sensu System Check is a cross-platform Sensu Metrics Check that provides baseline system metrics in prometheus format.

Output Metrics

cpu

Note 1: Metric tagged by cpu name with cpu-total meaning summed over all cpus on the system (Ex: cpu="cpu0", cpu="cpu-total")

mem

swap

load

host

Usage examples

Help output

Cross-platform System Check

Usage:
  system-check [flags]
  system-check [command]

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

Flags:
  -h, --help           help for system-check
  -i, --interval int   Interval in seconds over which to calculate cpu usage metrics (default 3)

Use "system-check [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/system-check

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: system-check
  namespace: default
spec:
  command: system-check
  subscriptions:
  - system
  runtime_assets:
  - sensu/system-check

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 system-check repository:

go build

Additional notes

Contributing

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