Sensu Platform Discovery

Table of Contents

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

Overview

Discover system platform information 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-platform-discovery -h
Discover system platform information and output a list of agent subscriptions.

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

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

Flags:
  -c, --get-cloud-provider   Determine the cloud provider and include it in subscriptions.
  -h, --help                 help for sensu-platform-discovery

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

$ sensu-platform-discovery
linux
debian

$ sensu-platform-discovery --get-cloud-provider
aws
linux
debian

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-platform-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-platform-discovery
  namespace: default
spec:
  command: sensu-platform-discovery --get-cloud-provider
  subscriptions:
  - discovery
  runtime_assets:
  - sensu/sensu-platform-discovery
  interval: 60

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

go build

Additional notes

Contributing

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