README.rst

Cabot RocketChat Plugin

Based on Cabot Hipechat Plugin (https://github.com/cabotapp/cabot-alert-hipchat).

This is an alert plugin for the cabot service monitoring tool. It allows you to alert users in a RocketChat channel.

Installation

• pip

  pip install cabot-alert-rocketchat

Dev environment

TODO

Configuration

• The plugin use Rocketchat webhooks (https://rocket.chat/docs/administrator-guides/integrations/)

• Enable rocketchat plugin on cabot:

  # Plugins to be loaded at launch
  CABOT_PLUGINS_ENABLED=...,cabot_alert_rocketchat

• Configuration available:

  • Common:

    # Channel used to publish messages
    ROCKETCHAT_CHANNEL=#support
    # Webhook URL with token
    ROCKETCHAT_WEBHOOK_URL=http://rocketchat.example.org/hooks/TOKEN
    # Username for messages. This username does not need to
    # exist on your Rocketchat, this is an alias.
    ROCKETCHAT_USERNAME=Cabot

  • Message format:

    # Collapse Service part
    ROCKETCHAT_COLLAPSED_SERVICE=False
    # Collapse Checks part
    ROCKETCHAT_COLLAPSED_CHECKS=False
    # Collapse Alert part
    ROCKETCHAT_COLLAPSED_ALERT=False

Example