check-unbound

Unbound check for Sensu

Table of Contents

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

Overview

The Check Unbound is a Sensu Check that report unbound statistics. The implementation of the pioneer https://github.com/letsencrypt/unbound_exporter is diverted.

Usage examples

Simple cross-platform Unbound checks

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

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

Flags:
  -b, --binary string   Location of the unbound-control binary (default "/usr/sbin/unbound-control")
  -c, --config string   Location of the Unbound config file
  -h, --help            help for check-unbound
  -s, --sudo            Execute with root privileges

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

If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/jadiunr/check-unbound].

Check definition

---
type: CheckConfig
api_version: core/v2
metadata:
  name: check-unbound
  namespace: default
spec:
  command: check-unbound --sudo
  subscriptions:
  - system
  runtime_assets:
  - jadiunr/check-unbound

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

go build

Additional notes

Contributing

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