Sensu Go Pushover Handler

• Overview
• Files
• Usage examples
• Configuration
  • Sensu Go
    • Asset registration
    • Asset definition
    • Handler definition
  • Sensu Core
• Installation from source
• Additional notes
• Contributing

Overview

The Senso Go Pushover Handler is a Sensu Event Handler for sending incident notifications to Pushover.

This handler reuses concepts found in the sensu-email-handler.

Files

N/A

Usage examples

Help

The Sensu Go Pushover handler for sending notifications.

Usage:
  sensu-go-pushover-handler [flags]

Flags:
  -C, --criticalPriority uint    The priority for Critical status messages (default 1)
  -h, --help                     help for sensu-go-pushover-handler
  -b, --messageBody string       The message body, in token substitution format (default "{{.Check.Output}}")
  -m, --messageTitle string      The message title, in token substitution format (default "{{.Entity.Name}}/{{.Check.Name}}")
  -O, --okPriority uint          The priority for OK status messages (default 0)
  -t, --pushoverToken string     The Pushover API token
  -u, --pushoverUserKey string   The Pushover API token
  -U, --unknownPriority uint     The priority for Unknown status messages (default 1)
  -W, --warningPriority uint     The priority for Warning status messages (default 0)

Configuration

Sensu Go

Asset registration

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 or later, you can use the following command to add the asset:

sensuctl asset add nixwiz/sensu-go-pushover-handler

If you're using an earlier version of sensuctl, you can download the asset definition from this project's Bonsai asset index page or one of the existing releases or create an executable script from this source.

From the local path of the sensu-go-pushover-handler repository:

go build -o /usr/local/bin/sensu-go-pushover-handler main.go

Asset definition

---
type: Asset
api_version: core/v2
metadata:
  name: sensu-go-pushover-handler
spec:
  url: https://assets.bonsai.sensu.io/68a80a140568696316455c2c6e43dfe4af472c67/sensu-go-pushover-handler_0.4.0_linux_amd64.tar.gz
  sha512: 7abb3c07d58d13607065250ca601056c54842764f199f7fbc55c2541fa5ffd9996c795063b81eef06de11d3067dbbafd9af5dbd937f257c6e55c2d5462c24f45

Handler definition

{
    "api_version": "core/v2",
    "type": "Handler",
    "metadata": {
        "namespace": "default",
        "name": "pushover"
    },
    "spec": {
        "type": "pipe",
        "command": "sensu-go-pushover-handler",
        "timeout": 10,
        "env_vars": [
            "SENSU_PUSHOVER_TOKEN=a0b1c2d3e4f5g6h7i8j9k0l1m2n3o4",
            "SENSU_PUSHOVER_USERKEY=a0b1c2d3e4f5g6h7i8j9k0l1m"
        ],
        "filters": [
            "is_incident",
            "not_silenced"
        ],
        "runtime_assets": [
            "sensu-go-pushover-handler"
        ]
    }
}

Sensu Core

N/A

Installation from source

Sensu Go

See the instructions above for asset registration.

Sensu Core

Install and setup plugins on Sensu Core.

Additional notes

Pushover Configuration

This handler makes use of Pushover's standard API mechanism. This means creating an application token, as well as
a user API key.

Use of tokens

For defining the message title and body, tokens from the events attributes are used.

Environment Variables and Annotations

Note: The command line arguments take precedence over the environment variables above.

Note: Annotations take precedence over command line arguments above.

Contributing

N/A