Select Supported Platforms

Select Supported Architectures

Select Tier

Github Name


v0.6.0 · public · Published about 1 month ago

README
Asset Definition
Release Notes
Release Assets

Sensu Bonsai Asset
Go Test
goreleaser
Go Report Card

Sensu Go Pushover Handler

Overview

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

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}}")
  -a, --pushoverAPIURL string    The Pushover API URL (default "https://api.pushover.net/1/messages")
  -s, --messageSound string      The sound for the message (default "pushover")
  -O, --okPriority uint          The priority for OK status messages (default 0)
  -t, --pushoverToken string     The Pushover API token
  -u, --pushoverUserKey string   The Pushover API user key
  -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.

To build from source, from the local path of the sensu-go-pushover-handler repository:

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

Handler definition

api_version: core/v2
type: Handler
metadata:
  namespace: default
  name: pushover
spec:
  type: pipe
  command: sensu-go-pushover-handler -b http://sensu-backend.example.com:3000
  filters:
  - is_incident
  - not_silenced
  runtime_assets:
  - nixwiz/sensu-go-pushover-handler
  secrets:
  - name: SENSU_PUSHOVER_TOKEN
    secret: pushover#token
  - name: SENSU_PUSHOVER_USERKEY
    secret: pushover#userkey
  timeout: 10

Security Note: The Pushover Token and UserKey should always be treated as
security sensitive configuration options and in this example, they are loaded
into the handler configuration as environment variables using secrets.
Command arguments are commonly readable from the process table by other
unpriviledged users on a system (ex: ps and top commands), so it's a better
practice to read in sensitive information via environment variables or
configuration files on disk. The --pushoverToken and --pushoverUserKey flags
are provided as an override for testing purposes.

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

Variable Setting Annotation
SENSU_PUSHOVER_TOKEN same as -t / --pushoverToken sensu.io/plugins/pushover/config/pushoverToken
SENSU_PUSHOVER_USERKEY same as -u / --pushoverUserKey sensu.io/plugins/pushover/config/pushoverUserKey
N/A same as -b / --messageBody sensu.io/plugins/pushover/config/messageBody
N/A same as -m / --messageTitle sensu.io/plugins/pushover/config/messageTitle

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

Note: Annotations take precedence over command line arguments above.

Contributing

N/A

Are you sure you want to report this asset?

Please describe the reason for reporting this asset. Our moderators will be notified and will disable the asset if it is found to be inappropriate.

×

You must be signed in to report this asset.

Sign In with Github

Download

×

Either download the source code:

Download Source

Or download the asset definition: