sensu-discord-handler

README

Sensu Discord Handler

Table of Contents

• Overview
• Usage examples
  • Help output
• Configuration
  • Asset registration
  • Handler definition
  • Annotations
• Installation from source
• Additional notes
• Contributing

Overview

The Sensu Discord Handler is a Sensu Event Handler that sends event to a configured Discord channel.
As it follows the Sensu Slack Handler, see also.

Usage examples

Help output

The Sensu Go Discord handler for notifying a channel.

Usage:
  sensu-discord-handler [flags]
  sensu-discord-handler [command]

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

Flags:
  -m, --alert-mention string          Specifies the mentions to use if --alert-on-critical is enabled (default "@everyone")
  -a, --alert-on-critical             The Discord notification will alert the channel with a specified mentions (--alert-mention)
  -i, --custom-avatar-url string      A URL to an image to use as the user avatar
  -u, --custom-username string        The username that messages will be sent as
  -t, --description-template string   The Discord notification output template, in Golang text/template format (default "{{ .Check.Output }}")
  -h, --help                          help for sensu-discord-handler
  -w, --webhook-url string            The WebHook URL to send messages to

Use "sensu-discord-handler [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/sensu-discord-handler

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/sensu-discord-handler].

Handler definition

---
type: Handler
api_version: core/v2
metadata:
  name: sensu-discord-handler
  namespace: default
spec:
  command: sensu-discord-handler -u Sensu
  type: pipe
  runtime_assets:
  - jadiunr/sensu-discord-handler
  secrets:
  - name: DISCORD_WEBHOOK_URL
    secret: discord-webhook-url
  timeout: 10

Proxy Support

This handler supports the use of the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof). HTTPS_PROXY takes precedence over HTTP_PROXY for https requests. The environment values may be either a complete URL or a "host[:port]", in which case the "http" scheme is assumed.

Annotations

All arguments for this handler are tunable on a per entity or check basis based on annotations. The annotations keyspace for this handler is sensu.io/plugins/sensu-discord-handler/config.

Examples

To change the example argument for a particular check, for that checks's metadata add the following:

type: CheckConfig
api_version: core/v2
metadata:
  annotations:
    sensu.io/plugins/sensu-discord-handler/config/alert-mention: "<@!1234567890>"
[...]

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-discord-handler repository:

go build

Additional notes

Contributing

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