cpu-process-profiler

README

CPU Usage Check with Process Profiler

Table of Contents

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

Overview

CPU Usage Check with Process Profiler is a Sensu Check that was built as an extension of the official check-cpu-usage check. At the time of this writing, it provides the same functionality as the original check-cpu-usage check, with the added benefit of providing a list of the 10 top resource intensive processes at the time that the check was carried out.

Usage examples

Check CPU usage and provide metrics with a list of top resource intensive processes

Usage:
  cpu-process-profiler [flags]
  cpu-process-profiler [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)
  -w, --warning float         Warning threshold for overall CPU usage (default 75)
  -s, --sample-interval int   Length of sample interval in seconds (default 2)
  -h, --help                  help for cpu-process-profiler

Use "cpu-process-profiler [command] --help" for more information about a command.

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 makijapan/cpu-process-profiler

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: cpu-process-profiler
  namespace: default
spec:
  command: >-
    cpu-process-profiler
    --critical 95
    --warning 85
    --sample-interval 2
  output_metric_format: nagios_perfdata
  output_metric_handlers:
    - influxdb
  subscriptions:
    - system
  runtime_assets:
    - makijapan/cpu-process-profiler

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 cpu-process-profiler repository:

go build

Contributing

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