This PR introduces the concept of health checking the core/system/status OPNsense api, before trying to scrape any metrics. The status is reported in the opnsense_up metric which seems to be the convention naming in the Prometheus world for this kind of checks.
Bonus:
UDP and ICMP protocol metrics
Fixes:
Readme and docker cosmetics
Type of change
Please delete options that are not relevant.
[x] New feature (non-breaking change which adds functionality)
[x] This change requires a documentation update
Checklist:
Please delete options that are not relevant.
[x] I have updated the docs/metrics.md file, when I introduced new metrics
[x] I have made corresponding changes to the documentation
[x] New and existing unit tests pass locally with my changes
FEATURE: implement health check and proto metrics
Description
This PR introduces the concept of health checking the
core/system/status
OPNsense api, before trying to scrape any metrics. The status is reported in theopnsense_up
metric which seems to be the convention naming in the Prometheus world for this kind of checks.Bonus:
Fixes:
Type of change
Please delete options that are not relevant.
Checklist:
Please delete options that are not relevant.