This repository has been archived by the owner on Mar 27, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
###Ragios (Saint Ruby) | ||
# Ragios (Saint Ruby) | ||
|
||
[![Build Status](https://travis-ci.org/obi-a/ragios.svg?branch=master)](https://travis-ci.org/obi-a/ragios) | ||
|
||
|
@@ -15,35 +15,45 @@ monitor = { | |
plugin: "uptime_monitor" | ||
} | ||
|
||
ragios.add(monitor) | ||
ragios.create(monitor) | ||
``` | ||
The above example adds a monitor to Ragios, the monitor uses an "uptime_monitor" plugin to monitor the website "http://mysite.com" for uptime. This monitor runs tests on the website every 5 minutes, if it detects the website is down, it sends an alert email to "[email protected]" via an email notifier. | ||
The above example creates a monitor that monitor uses an `uptime_monitor` plugin to monitor the website `http://mysite.com` for uptime. This monitor runs tests on the website every 5 minutes, if it detects the website is down, it sends an alert email to `[email protected]` via an email notifier. | ||
|
||
##Features: | ||
## Features: | ||
A small and minimal extensible design: | ||
* Users can add, update, start, stop, restart and delete monitors in simple Ruby code. [See details](http://www.whisperservers.com/ragios/ragios-saint-ruby/using-ragios/) | ||
|
||
* Plugins | ||
+ Ragios relies on plugins to perform tests on different types of systems. The plugins are plain old ruby objects, any test that could be performed in ruby code could be performed by Ragios. Developers can create plugins to meet their specific needs. | ||
+ Ragios relies on plugins to perform tests on different types of systems. The plugins are plain old ruby objects, any test/check that could be performed in ruby code could be performed by Ragios. Developers can create plugins to meet their specific needs. | ||
+ Ragios ships with a url_monitor plugin for monitoring http(s) endpoints for uptime | ||
|
||
* Notifications & Notifiers | ||
+ Notifications are sent out when a test fails and when the test passes again. | ||
+ Notification messages are generated from ERB templates which developers can easily customize. | ||
+ Multiple email addresses could be added to a monitor, so that when a test fails it notifies all the email addresses simultaneously. | ||
+ Multiple email addresses could be added to a monitor, so it notfies all email addresses when a test fails or recovers from failure. | ||
+ Ragios relies on Notifiers to send out notifications. The notifiers are pluggable plain old ruby objects. Any type of notification that could be implemented in Ruby code can be sent by Ragios, notifications by email, SMS, twitter etc. Developers can create notifiers to meet their specific needs. | ||
+ Ragios ships with a Gmail Notifier that sends notifications via gmail, Amazon SES notifier that sends notifications via Amazon Simple Email Service, and a twitter notifier that tweets notifications on twitter. | ||
+ Multiple notifiers could be added to one monitor, so when a test fails it could send out notifications via all the notifiers simultaneously. Example a monitor could be setup to send notifications via email, SMS and twitter simultaneously. | ||
+ Ragios ships with an Amazon SES notifier that sends notifications via Amazon Simple Email Service, developers can implement other types of notifiers. | ||
+ Multiple notifiers could be added to one monitor, so when a test fails or recovers from failure, it ssends out notifications via all the notifiers. For example a monitor could be setup to send notifications via email, SMS, Slack and twitter simultaneously. | ||
|
||
* REST API is available for interacting with Ragios. | ||
|
||
* A web admin dashboard (Web UI) is available for using Ragios | ||
|
||
* Ragios includes a Ruby client library that makes it easy to interact with Ragios directly with ruby code. | ||
|
||
* A Ragios instance running on a remote server can be controlled from anywhere using the Ruby client library or the REST API. | ||
|
||
* Ragios is designed to be modular, memory efficient, distributed, and scalable. | ||
|
||
* Ragios runs a set of tiny distributed microservices, communicating with each other via ZeroMQ, and packaged with docker-compose. | ||
|
||
* Only dependency to start run Ragios is docker-compose. | ||
|
||
|
||
|
||
I'm doing this just for fun and educational purposes. | ||
|
||
##Documentation: | ||
## Documentation: | ||
|
||
|
||
* [Ragios (Saint Ruby)](http://www.whisperservers.com/ragios/ragios-saint-ruby/) | ||
|
@@ -77,7 +87,7 @@ I'm doing this just for fun and educational purposes. | |
* [Events API](http://www.whisperservers.com/ragios/events-api/) | ||
|
||
|
||
##License: | ||
## License: | ||
MIT License. | ||
|
||
Copyright (c) 2014 Obi Akubue, obi-akubue.org | ||
Copyright (c) 2018 Obi Akubue, obi-akubue.org |