sensu-go-plivo-handler

README

Sensu Go plivo Handler Plugin

• Overview
• Usage examples
• Configuration
  • Asset registration
  • Asset definition
  • Handler definition
• Functionality
• Installation from source and contributing
• Additional notes

Overview

This handler enables Sensu Go users to send SMS alerts using plivo. There are some prerequisites that are required in order to be able to use this handler.

1. You must have a plivo account
2. You must obtain an auth token
3. You must obtain an account SID
4. You must have a plivo phone number

Once you have all of the above, you should be all set to use this handler. Read on to find more about how to use this handler.

Usage Examples

While this handler is meant to be run as part of a Sensu Go deployment, you can always run the binary directly to see what the options are, as well as test it to ensure that it work as expected.

Command line help

The Sensu Go Handler for plivo

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

Flags:
  -s, --accountSid  string   The account SID for your plivo account, uses the environment variable PLIVO_ACCOUNT_SID by default
  -t, --authToken   string   The authorization token for your plivo account, uses the environment variable PLIVO_AUTH_TOKEN by default
  -f, --fromNumber  string   Your plivo phone number, uses PLIVO_FROM_NUMBER by default
  -r, --recipient   string   The recipient's phone number, uses PLIVO_RECIPIENT_LIST by default
  -h, --help                 help for sensu-go-plivo-handler

Testing

To test and see if this handler works, do the following:

Clone the repo:

git clone github.com/ridewithgps/sensu-go-plivo-handler

Run the following command:

cat example-event.json | ./sensu-go-plivo-handler  -s ACCTSIDXXXXXXXXXXXX -t AUTHTOKENXXXXXXXXXX  -f +18558675309 -r "+18559990210<+18559990211"

You should then receive a message to your phone with the output of the error.

Using the handler with one or more contacts

It is possible to use this plugin with multiple contacts, rather than a single number. This pattern is what is known in Sensu parlance as "contact routing." More will be added here as Sensu documentation is updated to more accurately describe this pattern.

Configuration

Asset registration

Assets are the best way to make use of this handler. 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 ridewithgps/sensu-go-plivo-handler

Asset definition

You can download the asset definition there, or you can do a little bit of copy/pasta and use the one below:

{
  "type": "Asset",
  "api_version": "core/v2",
  "metadata": {
    "name": "sensu-go-plivo-handler",
    "namespace": "CHANGEME",
    "labels": {
    },
    "annotations": {
    }
  },
  "spec": {
    "url": "https://github.com/ridewithgps/sensu-go-plivo-handler/releases/download/0.0.1/sensu-go-plivo-handler_0.0.1_linux_amd64.tar.gz",
    "sha512": "d054f14570069301dedf600e58ca7df78bd74e83377a44fee969a898e75c40ce1a30ee7eb24ce1a1c7f31c820a84e33b74cfb5b69163af22a45d6745eae780f0",
    "filters": [
      "entity.system.os == 'linux'",
      "entity.system.arch == 'amd64'"
    ]
  }
}

---
type: Asset
api_version: core/v2
metadata:
  name: sensu-go-plivo-handler
  namespace: CHANGEME
  labels: {}
  annotations: {}
spec:
  url: https://github.com/ridewithgps/sensu-go-plivo-handler/releases/download/0.0.1/sensu-go-plivo-handler_0.0.1_linux_amd64.tar.gz
  sha512: d054f14570069301dedf600e58ca7df78bd74e83377a44fee969a898e75c40ce1a30ee7eb24ce1a1c7f31c820a84e33b74cfb5b69163af22a45d6745eae780f0
  filters:
  - entity.system.os == 'linux'
  - entity.system.arch == 'amd64'

NOTE: PLEASE ENSURE YOU UPDATE YOUR URL AND SHA512 BEFORE USING THE ASSET! If you don't, you might just be stuck on a super old version. Don't say I didn't warn you ¯\(ツ)/¯

Handler definition

Example Sensu Go definition:

JSON

{
  "type": "Handler",
  "api_version": "core/v2",
  "metadata": {
    "name": "sensu-go-plivo-handler",
    "namespace": "CHANGEME"
  },
  "spec": {
    "command": "sensu-go-plivo-handler -f +18558675309 -r +18559990210",
    "env_vars": [
      "PLIVO_ACCOUNT_SID=ACCTSIDXXXXXXXXXXXX",
      "PLIVO_AUTH_TOKEN=AUTHTOKENXXXXXXXXXX"
    ],
    "filters": [
      "is_incident",
      "not_silenced"
    ],
    "runtime_assets": [
      "sensu-go-plivo-handler"
    ],
    "timeout": 0,
    "type": "pipe"
  }

YAML

type: Handler
api_version: core/v2
metadata:
  name: sensu-go-plivo-handler
  namespace: default
spec:
  command: sensu-go-plivo-handler -f +18558675309 -r +18559990210
  env_vars:
  - PLIVO_ACCOUNT_SID=ACCTSIDXXXXXXXXXXXX
  - PLIVO_AUTH_TOKEN=AUTHTOKENXXXXXXXXXX
  filters:
  - is_incident
  - not_silenced
  runtime_assets:
  - sensu-go-plivo-handler
  timeout: 0
  type: pipe

Installation from Source and Contributing

While it's generally recommended to use an asset, you can download a copy of the handler plugin from releases, or create an executable script from this source.

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

go build -o build/bin/sensu-go-plivo-handler -ldflags "-linkmode external -extldflags -static" -a main.go

See CONTRIBUTING for more information on how to contribute to this plugin.

Additional notes

Supported operating systems

Support for this asset is as follows:

• Linux 64 bit
• Arm 64 bit

This is mostly due to the fact that this plugin is a handler. If you have the Sensu Go backend running on a different platform, open an issue and provide some further details about the platform you'd like to see supported.