mirror of https://github.com/alerta/alerta-contrib.git synced 2024-12-04 12:27:25 +00:00

History

Nick Satterly 2a6632b78f Fix multiple linting errors		2023-03-21 00:15:34 +01:00
..
alerta_cachet.py	Fix multiple linting errors	2023-03-21 00:15:34 +01:00
README.md	Update READMEs	2020-11-20 22:39:32 +01:00
setup.py	Fix multiple linting errors	2023-03-21 00:15:34 +01:00

README.md

Cachet Plugin

Send incidents to Cachet status page.

For help, join

Installation

Clone the GitHub repo and run:

$ python setup.py install

Or, to install remotely from GitHub run:

$ pip install git+https://github.com/alerta/alerta-contrib.git#subdirectory=plugins/cachet

Note: If Alerta is installed in a python virtual environment then plugins need to be installed into the same environment for Alerta to dynamically discover them.

Configuration

Add cachet to the list of enabled PLUGINS in alertad.conf server configuration file and set plugin-specific variables either in the server configuration file or as environment variables.

PLUGINS = ['cachet']
CACHET_API_URL = ''  # default="not set"
CACHET_API_TOKEN = ''  # default="not set"
CACHET_SSL_VERIFY = False

Troubleshooting

Restart Alerta API and confirm that the plugin has been loaded and enabled.

Set DEBUG=True in the alertad.conf configuration file and look for log entries similar to below:

References

Cachet status page docs: https://docs.cachethq.io/reference
Python Cachet Client: https://github.com/dmsimard/python-cachetclient