diff --git a/docs/uptime-monitor.md b/docs/uptime-monitor.md index 3906124..382248e 100644 --- a/docs/uptime-monitor.md +++ b/docs/uptime-monitor.md @@ -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. } ] } -``` \ No newline at end of file +``` + +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. +