Sensu VictorOps Handler

Table of Contents

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

Overview

The Sensu VictorOps Handler is a Sensu Go Handler for sending events to the
VictorOps incident response platform.

As of the initial version (0.1.x), this is meant to work in the same fashion as
the prior Ruby based plugin, sensu-plugins-victorops, with the following
changes:

• The environment variables for routing key and API URL are now
  SENSU_VICTOROPS_ROUTINGKEY and SENSU_VICTOROPS_APIURL, respectively
• Since Sensu Go events do not have an action, the RECOVERY message_type is
  based on event.check.status == 0

Files

N/A

Usage examples

Help

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

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

Flags:
  -a, --api-url string      The URL for the VictorOps API (default "https://alert.victorops.com/integrations/generic/20131114/alert")
  -h, --help                help for sensu-victorops-handler
  -r, --routingkey string   The VictorOps Routing Key

Environment Variables and Annotations

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 nixwiz/sensu-victorops-handler

If you're using an earlier version of sensuctl, you can find the asset on the
Bonsai Asset Index.

Resource definition

---
type: Handler
api_version: core/v2
metadata:
  name: sensu-victorops-handler
  namespace: default
spec:
  command: sensu-victorops-handler
  filters:
  - is_incident
  - not_silenced
  type: pipe
  runtime_assets:
  - nixwiz/sensu-victorops-handler
  secrets:
  - name: SENSU_VICTOROPS_ROUTINGKEY
    secret: victorops-routingkey

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

go build

Additional notes

N/A

Contributing

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