8000 Describe the diff.json endpoint in the README by ties · Pull Request #66 · bgp/stayrtr · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Describe the diff.json endpoint in the README #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2022
Merged

Describe the diff.json endpoint in the README #66

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c17aacb
Describe the diff.json endpoint in the README
ties May 12, 2022
8356125
Clarify that -file overrides the URL
ties May 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,20 @@ $ ./rtrmon \
-primary.refresh 30s
```

rtrmon has two endpoints:
* `/metrics`: for prometheus metrics
* `/diff.json` (default, can be overridden by the `-file` flag): 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:

Expand All @@ -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:
Expand Down
0