Update READMEs

This commit is contained in:
Nick Satterly 2020-11-20 22:39:32 +01:00
parent 63f8827c8b
commit bc0de15765
38 changed files with 38 additions and 38 deletions
integrations
consul
mailer
opsweekly
pinger
snmptrap
sqs
supervisor
syslog
urlmon
plugins
alertops
amqp
cachet
debug
enhance
forward
geoip
influxdb
logstash
msteams
normalise
op5
opsgenie
pagerduty
prometheus
pushover
rocketchat
slack
sns
syslog
telegram
twilio
zabbix
webhooks
azuremonitor
fail2ban
mailgun
msteams
sentry
statuscake

View file

@ -4,7 +4,7 @@ Consul Integration
Send alerts based on [consul](https://www.consul.io/). health checks,
triggered by [consul-alerts](https://github.com/AcalephStorage/consul-alerts)
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Prerequisites
-------------

View file

@ -3,7 +3,7 @@ Mailer Integration
Send emails for alerts received by Alerta.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Overview
--------

View file

@ -3,7 +3,7 @@ Opsweekly Integration
[Opsweekly](https://codeascraft.com/2014/06/19/opsweekly-measuring-on-call-experience-with-alert-classification/) is a tool developed by Etsy to generate weekly oncall support reports.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Pinger Integration
Monitor network availability using ICMP Ping and generate alerts on failures.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ SNMP Trap Integration
SNMP trap listener sends alerts to Alerta.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Prerequisites
-------------

View file

@ -3,7 +3,7 @@ Amazon SQS Integration
Subscribe to SQS queue of alerts.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Supervisor Integration
Trigger alerts and heartbeats based on process `supervisor` [events][1].
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -8,7 +8,7 @@ messages and forward to Alerta.
![Screenshot](./images/alerta-syslog.png)
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ URL Monitoring Integration
Monitor any web URL and generate alerts for slow, unresponsive or error responses.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -6,7 +6,7 @@ Trigger Alerts in AlertOps.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ AMQP Publisher Plugin
Publish alerts to an AMQP topic.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Cachet Plugin
Send incidents to Cachet status page.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Debug Plugin
Used for debugging only.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -12,7 +12,7 @@ Two alert attributes are added to all incoming alerts received by Alerta:
This repo should be forked or copied and the python plugin modified to suit
the specific Alerta environment.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Forward Plugin
This is an plugin that forward alert from one server to another.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ GeoIP Plugin
Use IP Geolocation to determine the physical location of the origin of alerts.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ InfluxDB Plugin
Write alert values to InfluxDB as time-series data.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Logstash Plugin
Log alerts to Kibana using Logstash.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -6,7 +6,7 @@ Send Microsoft Teams messages for new alerts.
If you have the Python Jinja2 package installed you can customize the
Microsoft Teams message format.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -13,7 +13,7 @@ Normalise actions:
This repo should be forked or copied and the python plugin modified to suit
the specific Alerta environment.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ OP5 Plugin
Send acknowledgments to OP5 monitor.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ OpsGenie Plugin
Send OpsGenie messages for new alerts.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -6,7 +6,7 @@ Send PagerDuty messages for new alerts.
**Tip: Use this plugin in conjunciton with the PagerDuty webhook which will notify
Alerta when a PagerDuty notification has been acknowledged or closed.**
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -5,7 +5,7 @@ Two-way integration with Prometheus which will silence alerts in
Alertmanager when alerts are ack'ed in the Alerta console and delete
silences if those alerts are manually re-opened.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Pushover.net Plugin
Send Pushover messages for new alerts.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -5,7 +5,7 @@ Post a [Rocket.Chat](https://rocket.chat) message for new alerts.
![Rocket.Chat Message](./images/alerta-rocketchat-plugin.png)
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -5,7 +5,7 @@ Send alerts to [Slack](https://slack.com/).
![Slack Message](./images/alerta-slack-plugin.png)
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ AWS SNS Plugin
Send alerts to AWS SNS topic.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Syslog Plugin
Log alerts to syslog.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -5,7 +5,7 @@ Send alerts to Telegram Bot.
![Telegram Message](./images/alerta-telegram-plugin.png)
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Twilio SMS Plugin
Send SMS messages for new alerts using Twilio.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -4,7 +4,7 @@ Zabbix Plugin
Two-way integration with Zabbix which will acknowledge events in
Zabbix when alerts are ack'ed or closed in the Alerta console.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Azure Monitor Webhook
Receive [Azure Monitor](https://azure.microsoft.com/services/monitor/) notifications via webhook callbacks.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Fail2Ban Webhook
Receive [Fail2Ban](https://www.fail2ban.org) ban notifications via webhook callbacks.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Mailgun incomming email Webhook
Receive Emails using [Mailgun](https://documentation.mailgun.com/en/latest/quickstart-receiving.html) webhook callbacks.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ MS Teams Webhook
Receive HttpPOST ack,close and blackout actions via webhook callbacks.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------

View file

@ -3,7 +3,7 @@ Sentry Webhook
Receive [Sentry](https://sentry.io) exception notifications via webhook callbacks.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Sentry callback version support
-------------------------------

View file

@ -3,7 +3,7 @@ Statuscake Webhook
Receive [Statuscake](https://www.statuscake.com) alerts via webhook callbacks.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
Installation
------------