Skip to main content

A RocketChat alert plugin for Cabot

Project description

https://travis-ci.org/ObjectifLibre/cabot-alert-rocketchat.svg?branch=master

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

docs/images/ex_messages.png

Project details


Download files

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

Files for cabot-alert-rocketchat, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size cabot_alert_rocketchat-0.1.2-py2-none-any.whl (5.7 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size cabot-alert-rocketchat-0.1.2.tar.gz (4.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page