mirror/nttgin-BGPalerter
1
0
Fork 0
mirror of https://github.com/nttgin/BGPalerter.git synced 2024-05-19 06:50:08 +00:00
Code Issues Releases Wiki Activity

some fixes on the doc

Browse Source
This commit is contained in:
Massimo Candela
2019-07-15 10:42:12 +00:00
parent d6c23dc5d2
commit c74c5ca4e4
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -78,13 +78,14 @@ To start develop:
You can compose the tool with 3 main components: connectors, monitors, and reports. 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. 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. From the super class they will inherit various generic methods while some specific for the particular component have to be implemented.
Reports don't receive only alerts but also the data that provoked such alerts.
In config.yml, for each collection of components: In config.yml, for each collection of components:
* file - refers to the file name which contains the class * file - refers to the file name which contains the class
* channel(s) - refer to what channel will be used to send/receive messages * channels - refer to what channel(s) will be used to send/receive messages
* params - whatever param it may be needed to the component at creation time * params - whatever param it may be needed to the component at creation time