Skip to main content

A sensu plugin to send events to rocketchat.

Project description

sensu-handler-rocketchat

This is a notification handler for Sensu written in Python. It should also work with Slack and any other Chat service which uses Slack compatible WebHooks.

Why this and not sensu-plugins-slack?

Because it was easier to rewrite this in Python than to figure out how to quote and escape JSON in ERB in a JSON config file ;-). The orignal sensu plugin identifies monitored hosts by their IP address, which is not helpful, when using cloud setups, where IPs may repeat.

Usage

Create a handler config for sensu:

{
  "handlers": {
    "rockethandler": {
      "type": "pipe",
      "filters": [ "state_change_only" ],
      "command": "sensu-handler-rocketchat"
    }
  }
}

Refer to the sensu documentation for more info on how to write this.

Then create the config for this specific handler. The default config section is “rockethandler”, but this can be overridden on the commandline, to enable handling multiple channels or Rocketchat servers.

{
  "rockethandler": {
    "hook_url": "https://rocketchat.example.com/hooks/iPw6s7Ykseuhf88kkhf8s4fn0392cnfh83mcfnbsWCzxHTSK",
    "nickname": "sensu",
    "channel": "openstack-events",
    "dashboard_url": "http://10.0.1.4:3000",
    "pretext": ""
  }
}

Parameters

  • hook_url: (required) Full URL to the WebHook (incoming integration) you want to use.

  • nickname: (optional) Nickname to use by the handler. Defaults to “RocketChat defined”.

  • channel: (optional) Channel name to deliver notification to. Defaults to “RocketChat defined”.

  • dashboard_url: (optional) URL to uchiwa or sensu dashboard (root URL). This is used to create a link in the title of every notification

  • pretext: (optional) Text to prepend to each notification. Can be used e.g. for highlights.

Changing config namespace

By default the handler will use the top-level namespace “rockethandler” in the sensu config. If you need to notify multiple channels depending on different events you can define multiple config under different namespaces.

These configs can then be referenced by using the -c namespace commandline argument

Example:

rockethandler config
{
  "rockethandler": {
    "hook_url": "https://rocketchat.example.com/hooks/iPw6s7Ykseuhf88kkhf8s4fn0392cnfh83mcfnbsWCzxHTSK",
    "nickname": "sensu",
    "channel": "all-events",
    "dashboard_url": "http://10.0.1.4:3000",
    "pretext": ""
  },
  "rockethandler_1": {
    "hook_url": "https://rocketchat.example.com/hooks/iPw6s7Ykseuhf88kkhf8s4fn0392cnfh83mcfnbsWCzxHTSK",
    "nickname": "sensu-emerg",
    "channel": "emergency-events",
    "dashboard_url": "http://10.0.1.4:3000",
    "pretext": "@all"
  },
  "rockethandler_2": {
    "hook_url": "https://rocketchat.example.com/hooks/iPw6s7Ykseuhf88kkhf8s4fn0392cnfh83mcfnbsWCzxHTSK",
    "nickname": "sensu-resolve",
    "channel": "all-events",
    "dashboard_url": "http://10.0.1.4:3000",
    "pretext": "**PROBLEM RESOLVED**"
  }
}
sensu handler config
{
  "handlers": {
    "rocket_handler": {
      "type": "pipe",
      "filters": [ "state_change_only" ],
      "command": "sensu-handler-rocketchat"
    },
    "rocket_handler": {
      "type": "pipe",
      "filters": [ "state_change_only", "emergency" ],
      "command": "sensu-handler-rocketchat -c rockethandler_1"
    },
    "rocket_handler": {
      "type": "pipe",
      "filters": [ "state_change_only", "resolution" ],
      "command": "sensu-handler-rocketchat -c rockethandler_2"
    }
  }
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sensu-handler-rocketchat-0.1.0.tar.gz (3.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page