sensu-handler-betteruptime

README

BetterUptime

Table of Contents

• BetterUptime
  • Table of Contents
  • Overview
  • Files
  • Usage examples
  • Configuration
    • Asset registration
    • Handler definition
    • Annotations
      • Examples
  • Installation from source
  • Additional notes
  • Contributing

Overview

sensu-handler-betteruptime is a Sensu Handler built using the Sensu Plugin SDK. This is a way to create incident using API on better uptime.

Files

Usage examples

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 agm650/sensu-handler-betteruptime

If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/agm650/sensu-handler-betteruptime].

Handler definition

---
type: Handler
api_version: core/v2
metadata:
  name: sensu-handler-betteruptime
  namespace: default
spec:
  command: sensu-handler-betteruptime --token better_uptime_token
  type: pipe
  runtime_assets:
  - agm650/sensu-handler-betteruptime

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 betteruptime/config/name.

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:
    betteruptime/config/name: "Name of the Event"
    betteruptime/config/summary: "Summary of the Event"
    betteruptime/config/description: "Description of the incident"
    betteruptime/config/email: "requester.email@domain.com"
[...]

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

go build

Additional notes

Contributing

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