isabella232 / sensu-process-discovery

Discover system processes and output a list of agent subscriptions.

Sensu Process Discovery

Table of Contents

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

Overview

Discover system processes and output a list of agent subscriptions. This plugin can be used in combination with the Sensu Entity Manager handler to automate Sensu Go agent subscription management.

Usage examples

$ sensu-process-discovery -h
Discover system processes and output a list of agent subscriptions.

Usage:
  sensu-process-discovery [flags]
  sensu-process-discovery [command]

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

Flags:
  -h, --help                         help for sensu-process-discovery
  -p, --subscription-prefix string   The agent subscription name prefix

Use "sensu-process-discovery [command] --help" for more information about a command.

$ sensu-process-discovery 
syslog
docker
postgres
sensu-backend

$ sensu-process-discovery -p ad:
ad:syslog
ad:docker
ad:postgres
ad:sensu-backend

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/sensu-process-discovery

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: sensu-process-discovery
  namespace: default
spec:
  command: sensu-process-discovery -p ad:
  subscriptions:
  - discovery
  runtime_assets:
  - sensu/sensu-process-discovery

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-process-discovery repository:

go build

Additional notes

Contributing

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