Merge pull request from alerta/more-readmes

Update READMEs
This commit is contained in:
Nick Satterly 2016-12-10 17:32:55 +00:00 committed by GitHub
commit 1accde44b8
8 changed files with 216 additions and 58 deletions
integrations

View file

@ -0,0 +1,29 @@
PagerDuty Integration
=====================
Send PagerDuty notifications based on alerts.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
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=integrations/pagerduty
Configuration
-------------
References
----------
License
-------
Copyright (c) 2015-2016 Nick Satterly. Available under the MIT License.

View file

@ -0,0 +1,36 @@
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)
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=integrations/pinger
Configuration
-------------
Add "ping targets" to `/etc/alerta/alert-pinger.targets`:
```yaml
```
References
----------
License
-------
Copyright (c) 2014-2016 Nick Satterly. Available under the MIT License.

View file

@ -1 +0,0 @@
alerta-server

View file

@ -1,12 +1,5 @@
#!/usr/bin/env python
import os
import sys
try:
from setuptools import setup
except ImportError:
from distutils.core import setup
from setuptools import setup, find_packages
setup(
name="alerta-pinger",
@ -18,7 +11,7 @@ setup(
url="http://github.com/alerta/alerta-contrib",
py_modules=['pinger'],
install_requires=[
'alerta-server',
'alerta',
],
entry_points={
'console_scripts': [
@ -35,4 +28,3 @@ setup(
'Topic :: System :: Monitoring',
]
)

View file

@ -1,27 +1,36 @@
Alert on SNMP Traps
-------------------
SNMP Trap Integration
=====================
Usage
-----
SNMP trap listener sends alerts to Alerta.
Runs as a trap handler by Net-SNMP snmptrapd.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
Requires
--------
Prerequisites
-------------
* Net-SNMP snmptrapd package.
* Net-SNMP snmptrapd package - integration runs as a trap handler by Net-SNMP snmptrapd
To install `net-snmp` on RedHat/Centos Linux:
$ yum -y install net-snmp net-snmp-utils
Installation
------------
$ git clone ...
$ sudo python setup.py install
Clone the GitHub repo and run:
$ yum -y install net-snmp net-snmp-utils
$ python setup.py install
Or, to install remotely from GitHub run:
$ pip install git+https://github.com/alerta/alerta-contrib.git#subdirectory=integrations/snmptrap
Configuration
-------------
Configure `snmptrapd` to execute `alerta-snmptrap` when an SNMP trap is
received:
$ vi /etc/snmp/snmptrapd.conf
authCommunity log,execute,net public
@ -34,9 +43,8 @@ Configuration
$ service snmptrapd start
Trouble Shooting
----------------
Troubleshooting
---------------
1. Stop `snmptrapd` and run it in the foreground:
@ -49,4 +57,14 @@ Trouble Shooting
3. Send test trap:
$ snmptrap -v2c -c public localhost "" .1.3.6.1.6.3.1.1.5.3.0 0 s "This is a test linkDown trap"
$ snmptrap -v2c -c public localhost "" .1.3.6.1.6.3.1.1.5.3.0 0 s "This is a test linkDown trap"
References
----------
* Configuring SNMP Trapd: http://net-snmp.sourceforge.net/wiki/index.php/TUT:Configuring_snmptrapd
License
-------
Copyright (c) 2014-2016 Nick Satterly. Available under the MIT License.

View file

@ -1,33 +1,43 @@
Supervisor
==========
Supervisor Integration
======================
Trigger alerts and heartbeats based on `supervisor` [events][1].
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)
Installation
------------
Install supervisor and alerta python SDK:
Clone the GitHub repo and run:
$ sudo pip install supervisor alerta
$ python setup.py install
Or, to install remotely from GitHub run:
$ pip install git+https://github.com/alerta/alerta-contrib.git#subdirectory=integrations/supervisor
Configuration
-------------
Copy the example configuration file `supervisord.conf.example` to /etc and modify for your environment:
Copy the example configuration file `supervisord.conf.example` to `/etc`
and modify for your environment:
$ sudo cp supervisord.conf.example /etc/supervisord.conf
$ sudo vi /etc/supervisord.conf
Usage
-----
$ sudo supervisord
Trouble Shooting
----------------
Troubleshooting
---------------
$ sudo supervisord -c supervisord.conf.example -n
References
----------
[1]: <http://supervisord.org/events.html> "Supervisor Events"
* supervisord Events: http://supervisord.org/events.html
License
-------
Copyright (c) 2015-2016 Nick Satterly. Available under the MIT License.

View file

@ -1,21 +1,30 @@
alerta-syslog
=============
Syslog Integration
==================
Receive [RFC 5424](https://tools.ietf.org/html/rfc5424.html),
[RFC 3164](https://tools.ietf.org/html/rfc3164.html) syslog and
[Cisco syslog](http://www.cisco.com/c/en/us/td/docs/routers/access/wireless/software/guide/SysMsgLogging.html)
messages and forward to Alerta.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/chat)
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=integrations/syslog
Configuration
-------------
Use environment variables to configure `alerta-syslog`. To use non-standard syslog ports:
Use environment variables to configure `alerta-syslog`. To use non-standard
syslog ports:
$ export SYSLOG_TCP_PORT=1514
$ export SYSLOG_UDP_PORT=1514
@ -25,8 +34,9 @@ To configure the API endpoint and API key (if required) set the following:
$ export ALERTA_ENDPOINT=https://api.alerta.io
$ export ALERTA_API_KEY=demo-key
NOTE: if syslog msgs aren't being split on newlines and #012 appears instead then
try adding "$EscapeControlCharactersOnReceive off" to rsyslog.conf
NOTE: If using `rsyslog` and syslog msgs aren't being split on
newlines and `#012` appears instead then try adding
`$EscapeControlCharactersOnReceive off` to `rsyslog.conf`.
Testing
@ -46,20 +56,15 @@ To generate example syslog messages on a Mac follow the steps below:
$ logger -i -s -p mail.err -t TEST "mail server is down"
$ logger -p local0.notice -t HOSTIDM
References
----------
* RFC 5424: https://tools.ietf.org/html/rfc5424.html
* RFC 3164: https://tools.ietf.org/html/rfc3164.html
* Cisco Syslog: http://www.cisco.com/c/en/us/td/docs/routers/access/wireless/software/guide/SysMsgLogging.htm
* Rsyslog: http://www.rsyslog.com/
License
-------
Alerta monitoring system and console
Copyright 2014-2016 Nick Satterly
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Copyright (c) 2014-2016 Nick Satterly. Available under the MIT License.

View file

@ -0,0 +1,69 @@
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)
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=integrations/urlmon
Configuration
-------------
Add URLs to check to `settings.py`:
url = check['url']
post = check.get('post', None)
count = check.get('count', 1)
headers = check.get('headers', {})
username = check.get('username', None)
password = check.get('password', None)
realm = check.get('realm', None)
uri = check.get('uri', None)
proxy = check.get('proxy', False)
status_regex = check.get('status_regex', None)
search_string = check.get('search', None)
rule = check.get('rule', None)
warn_thold = check.get('warning', SLOW_WARNING_THRESHOLD)
crit_thold = check.get('critical', SLOW_CRITICAL_THRESHOLD)
```
checks = [
{
"resource": "www.google.com",
"url": "http://www.google.com?q=foo#q=foo",
"environment": "Production",
"service": ["Google", "Search"]
},
{
"resource": "guardian-football",
"url": "http://www.guardian.co.uk/football",
"environment": "Production",
"service": ["theguardian.com", "Sport"],
"tags": ["football"]
},
]
```
**Regex Matches**
References
----------
License
-------
Copyright (c) 2014-2016 Nick Satterly. Available under the MIT License.