sensu-supervisor-check

README

Supervisor Check for Sensu Go

Table of Contents

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

Overview

The Supervisor Check for Sensu Go is a Sensu Check that reports on the status of processes managed by Supervisor.

Files

N/A

Usage examples

Supervisor Check for Sensu Go

Usage:
  sensu-supervisor-check [flags]
  sensu-supervisor-check [command]

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

Flags:
  -c, --critical string   Supervisor states to consider critical (default "FATAL")
  -h, --help              help for sensu-supervisor-check
  -H, --host string       Host running Supervisor (default "localhost")
  -P, --port int          Supervisor listening port (default 9001)
  -s, --socket string     Supervisor listening UNIX domain socket

Use "sensu-supervisor-check [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 nixwiz/sensu-supervisor-check

If you're using an earlier version of sensuctl, you can find the asset on the Bonsai Asset Index

Check definition

NOTE: This plugin does not currently support the use of username/password authentication to the Supervisor URL or UNIX domain socket.

Using HTTP

---
type: CheckConfig
api_version: core/v2
metadata:
  name: sensu-supervisor-check
  namespace: default
spec:
  command: sensu-supervisor-check --host super.example.com --port 9001 -c STARTING,BACKOFF,STOPPING,EXITED,FATAL,UNKNOWN,STOPPED
  subscriptions:
  - system
  runtime_assets:
  - nixwiz/sensu-supervisor-check

Using a UNIX domain socket

---
type: CheckConfig
api_version: core/v2
metadata:
  name: sensu-supervisor-check
  namespace: default
spec:
  command: sensu-supervisor-check -s /var/run/supervisor.sock -c STARTING,BACKOFF,STOPPING,EXITED,FATAL,UNKNOWN,STOPPED
  subscriptions:
  - system
  runtime_assets:
  - nixwiz/sensu-supervisor-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 sensu-supervisor-check repository:

go build

Additional notes

Contributing

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