Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sapcc/ntp_exporter
Prometheus exporter for NTP offset/stratum of a client
https://github.com/sapcc/ntp_exporter
Last synced: 11 days ago
JSON representation
Prometheus exporter for NTP offset/stratum of a client
- Host: GitHub
- URL: https://github.com/sapcc/ntp_exporter
- Owner: sapcc
- License: apache-2.0
- Created: 2017-01-13T14:42:57.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T13:14:13.000Z (7 months ago)
- Last Synced: 2024-04-12T16:37:26.559Z (7 months ago)
- Language: Go
- Size: 5.98 MB
- Stars: 43
- Watchers: 42
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# ntp\_exporter
[](https://github.com/sapcc/ntp_exporter/actions/workflows/ci.yaml)
This is a Prometheus exporter that, when running on a node, checks the drift
of that node's clock against a given NTP server or servers.
These are the metrics supported.
- `ntp_build_info`
- `ntp_drift_seconds`
- `ntp_stratum`
- `ntp_rtt_seconds`
- `ntp_reference_timestamp_seconds`
- `ntp_root_delay_seconds`
- `ntp_root_dispersion_seconds`
- `ntp_root_distance_seconds`
- `ntp_precision_seconds`
- `ntp_leap`
- `ntp_scrape_duration_seconds`
- `ntp_server_reachable`
As an alternative to [the node-exporter's `time` module](https://github.com/prometheus/node_exporter/blob/master/docs/TIME.md), this exporter does not require an NTP component on localhost that it can talk to. We only look at the system clock and talk to the configured NTP server(s).
## Installation
Compile `make && make install` or `docker build`. The binary can also be
installed with `go get`:
```bash
go install github.com/sapcc/ntp_exporter@latest
```
We also publish pre-built images on Docker Hub as
[sapcc/ntp-exporter](https://hub.docker.com/r/sapcc/ntp-exporter):
```bash
docker pull ghcr.io/sapcc/ntp_exporter:v2.2.0
```
## Usage
Common command-line options:
```
-ntp.source string
source of information about ntp server (cli / http). (default "cli")
-version
Print version information.
-web.listen-address string
Address on which to expose metrics and web interface. (default ":9559")
-web.telemetry-path string
Path under which to expose metrics. (default "/metrics")
```
### Mode 1: Fixed NTP server
By default, or when the option `-ntp.source cli` is specified, the NTP server
and connection options is defined by command-line options:
```
-ntp.measurement-duration duration
Duration of measurements in case of high (>10ms) drift. (default 30s)
-ntp.high-drift duration
High drift threshold. (default 10ms)
-ntp.protocol-version int
NTP protocol version to use. (default 4)
-ntp.server string
NTP server to use (required).
```
Command-line usage example:
```sh
ntp_exporter -ntp.server ntp.example.com -web.telemetry-path "/probe" -ntp.measurement-duration "5s" -ntp.high-drift "50ms"
```
### Mode 2: Variable NTP server
When the option `-ntp.source http` is specified, the NTP server and connection
options are obtained from the query parameters on each `GET /metrics` HTTP
request:
- `target`: NTP server to use
- `protocol`: NTP protocol version (2, 3 or 4)
- `duration`: duration of measurements in case of high drift
- `high_drift`: High drift threshold to trigger multiple probing
For example:
```sh
$ curl 'http://localhost:9559/metrics?target=ntp.example.com&protocol=4&duration=10s&high_drift=100ms'
```
## Frequently asked questions (FAQ)
### Is there a metric for checking that the exporter is working?
Several people have suggested adding a metric like `ntp_up` that's always 1, so
that people can alert on `absent(ntp_up)` or something like that. This is not
necessary. [Prometheus already generates such a metric by itself during
scraping.](https://prometheus.io/docs/concepts/jobs_instances/) A suitable
alert expression could look like
```
up{job="ntp_exporter",instance="example.com:9559"} != 1 or absent(up{job="ntp_exporter",instance="example.com:9559"})
```
but the concrete labels will vary depending on your setup and scrape configuration.