mirror/bgp-stayrtr
1
0
Fork 0
mirror of https://github.com/bgp/stayrtr.git synced 2024-05-06 15:54:54 +00:00
Code Issues Activity

Describe the diff.json endpoint in the README

Browse Source 
Adds a description of the diff.json endpoint.
This commit is contained in:
Ties de Kock
2022-05-12 14:25:51 +02:00
committed by GitHub
parent f28392e78a
commit c17aacb8ef
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -266,6 +266,20 @@ $ ./rtrmon \
-primary.refresh 30s
```
rtrmon has two endpoints:
* `/metrics`: for prometheus metrics
* `/diff.json` (default): for a JSON file containing the difference between sources
### diff
The `diff.json` endpoint contains four keys.
* `metadata-primary`: configuration of the primary source
* `metadata-secondary`: configuration of the secondary source
* `only-primary`: objects in the primary source but not in the secondary source.
* `only-secondary`: objects in the secondary source but not in the primary source.
### Metrics
By default the Prometheus endpoint is on `http://[host]:9866/metrics`.
Among others, this endpoint contains the following metrics:
@ -287,6 +301,8 @@ Using these metrics you can visualise or alert on, for example:
* Do both my RP instances see the same objects eventually?
* Are objects first visible in the JSON `difference` (e.g. 1706) seconds ago visible in RTR?
When the objects are not converging, the `diff.json` endpoint may help while investigating the issues.
### Data sources
Use your own validator, as long as the JSON source follows the following schema: