From 1b904f88fdbe6d8aa8c09bba06b7982cfb421e6b Mon Sep 17 00:00:00 2001 From: MaxCam Date: Thu, 11 Jul 2019 10:26:48 +0000 Subject: [PATCH] README.md edited online with Bitbucket --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index f2afddd..ec0f693 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ ##For Users ###Composition + You can compose the tool with 3 main components: connectors, monitors, and reports. Connectors retrieve/listen the data from different sources and transform them in a common format. @@ -25,13 +26,17 @@ Monitors analize the data flow and produce alerts. Different monitors try to det Reports send/store the alerts, e.g. by email or to a file. ####connectors + Possible connectors are: + * connectorRIS, for real-time data from RIPE RIS (https://ris-live.ripe.net/) * connectorTest, for testing purposes, it provokes all types of alerting ####monitors + Possible monitors are: + * monitorHijack, for monitoring hijacks * monitorVisibility, for monitoring prefixes visibility (you will get notified when withdrawals make monitored routes disappear). A threshold can be specified in config.yml to trigger an alert only if the issue is visible from a certain amount of peers. @@ -39,13 +44,17 @@ Possible monitors are: * monitorNewPrefix, for monitoring if new more specifics (of the monitored prefixes) start to be announced ####reports + Possible reports are: + * reportEmail, to send alerts by email. Smtp configurations are in config.yml * reportFile, to log the alerts in files. File directory, format, and log rotation configurations are in config.yml ##For Developers + To start develop: + 1. git clone this repo 2. execute "yarn" to install all dependencies @@ -53,6 +62,7 @@ To start develop: 3. run "npm watch-and-serve" to run the application. At every file change it will self-reload. ###npm commands + * "npm watch-and serve" to run the application from source code and monitor for file changes * "npm serve" to run the application from the source @@ -62,11 +72,13 @@ To start develop: * "npm build" to compile and buil native applications ###Composition + You can compose the tool with 3 main components: connectors, monitors, and reports. All connectors must extend the class Connector. Monitors extend the class Monitor. Reports extend the class Report. From the super class they will inherit various generic methods wile some specific for the particular component have to be implemented. In config.yml, for each collection of components: + * file - refers to the file name which contains the class * channel(s) - refer to what channel will be used to send/receive messages