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

Update uptime-monitor.md

Browse Source
This commit is contained in:
Massimo Candela
2019-12-06 14:42:38 +01:00
committed by GitHub
parent 7ec9b3b12e
commit 9a0eda4091
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/uptime-monitor.md
View File

@@ -1,11 +1,8 @@
# Uptime Monitor
# Uptime monitoring
The Uptime Monitor is a feature that allows to monitor the status of BGPalerter.
The API is reachable at `http://localhost:8011/status`.
The API, in addition to the JSON answer, can use HTTP status codes for an easier integration with Nagios and similar.
Since version 1.22.0 it is possible to monitor the status of the BGPalerter process through an API.
When this feature is disabled, no extra dependencies are loaded and no open port is required.
Please, see [configuration](configuration.md) for all the possible configuration parameters.
The API is reachable at `http://localhost:8011/status` and provides a summary of the status of various components of BGPalerter. If any of the components is having a problem, the attribute `warning` is set to true.
The following is an example of the API output.
@@ -19,4 +16,10 @@ The following is an example of the API output.
}
]
}
```
```
When the API is disabled (default), no extra dependencies are loaded and no open port is required.
The API, in addition to the JSON answer, can use HTTP status codes for an easier integration with Nagios and similar.
Please, see [configuration](configuration.md) for all the possible configuration parameters.