From 87d772a7d708fec12f48cd8adc0dedff6e1025da Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 26 Aug 2024 10:15:20 +0200 Subject: Adding upstream version 1.47.0. Signed-off-by: Daniel Baumann --- .../go.d.plugin/modules/ntpd/integrations/ntpd.md | 228 --------------------- 1 file changed, 228 deletions(-) delete mode 100644 src/go/collectors/go.d.plugin/modules/ntpd/integrations/ntpd.md (limited to 'src/go/collectors/go.d.plugin/modules/ntpd/integrations/ntpd.md') diff --git a/src/go/collectors/go.d.plugin/modules/ntpd/integrations/ntpd.md b/src/go/collectors/go.d.plugin/modules/ntpd/integrations/ntpd.md deleted file mode 100644 index f75cb7875..000000000 --- a/src/go/collectors/go.d.plugin/modules/ntpd/integrations/ntpd.md +++ /dev/null @@ -1,228 +0,0 @@ - - -# NTPd - - - - - -Plugin: go.d.plugin -Module: ntpd - - - -## Overview - -This collector monitors the system variables of the local `ntpd` daemon (optional incl. variables of the polled peers) using the NTP Control Message Protocol via UDP socket, similar to `ntpq`, the [standard NTP query program](https://doc.ntp.org/current-stable/ntpq.html). - - - - -This collector is supported on all platforms. - -This collector supports collecting metrics from multiple instances of this integration, including remote instances. - - -### Default Behavior - -#### Auto-Detection - -This integration doesn't support auto-detection. - -#### Limits - -The default configuration for this integration does not impose any limits on data collection. - -#### Performance Impact - -The default configuration for this integration is not expected to impose a significant performance impact on the system. - - -## Metrics - -Metrics grouped by *scope*. - -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. - - - -### Per NTPd instance - -These metrics refer to the entire monitored application. - -This scope has no labels. - -Metrics: - -| Metric | Dimensions | Unit | -|:------|:----------|:----| -| ntpd.sys_offset | offset | milliseconds | -| ntpd.sys_jitter | system, clock | milliseconds | -| ntpd.sys_frequency | frequency | ppm | -| ntpd.sys_wander | clock | ppm | -| ntpd.sys_rootdelay | delay | milliseconds | -| ntpd.sys_rootdisp | dispersion | milliseconds | -| ntpd.sys_stratum | stratum | stratum | -| ntpd.sys_tc | current, minimum | log2 | -| ntpd.sys_precision | precision | log2 | - -### Per peer - -These metrics refer to the NTPd peer. - -Labels: - -| Label | Description | -|:-----------|:----------------| -| peer_address | peer's source IP address | - -Metrics: - -| Metric | Dimensions | Unit | -|:------|:----------|:----| -| ntpd.peer_offset | offset | milliseconds | -| ntpd.peer_delay | delay | milliseconds | -| ntpd.peer_dispersion | dispersion | milliseconds | -| ntpd.peer_jitter | jitter | milliseconds | -| ntpd.peer_xleave | xleave | milliseconds | -| ntpd.peer_rootdelay | rootdelay | milliseconds | -| ntpd.peer_rootdisp | dispersion | milliseconds | -| ntpd.peer_stratum | stratum | stratum | -| ntpd.peer_hmode | hmode | hmode | -| ntpd.peer_pmode | pmode | pmode | -| ntpd.peer_hpoll | hpoll | log2 | -| ntpd.peer_ppoll | ppoll | log2 | -| ntpd.peer_precision | precision | log2 | - - - -## Alerts - -There are no alerts configured by default for this integration. - - -## Setup - -### Prerequisites - -No action required. - -### Configuration - -#### File - -The configuration file name for this integration is `go.d/ntpd.conf`. - - -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). - -```bash -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata -sudo ./edit-config go.d/ntpd.conf -``` -#### Options - -The following options can be defined globally: update_every, autodetection_retry. - - -
Config options - -| Name | Description | Default | Required | -|:----|:-----------|:-------|:--------:| -| update_every | Data collection frequency. | 1 | no | -| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | -| address | Server address in IP:PORT format. | 127.0.0.1:123 | yes | -| timeout | Connection/read/write timeout. | 1 | no | -| collect_peers | Determines whether peer metrics will be collected. | no | no | - -
- -#### Examples - -##### Basic - -A basic example configuration. - -
Config - -```yaml -jobs: - - name: local - address: 127.0.0.1:123 - -``` -
- -##### With peers metrics - -Collect peers metrics. - -
Config - -```yaml -jobs: - - name: local - address: 127.0.0.1:123 - collect_peers: yes - -``` -
- -##### Multi-instance - -> **Note**: When you define multiple jobs, their names must be unique. - -Collecting metrics from local and remote instances. - - -
Config - -```yaml -jobs: - - name: local - address: 127.0.0.1:123 - - - name: remote - address: 203.0.113.0:123 - -``` -
- - - -## Troubleshooting - -### Debug Mode - -To troubleshoot issues with the `ntpd` collector, run the `go.d.plugin` with the debug option enabled. The output -should give you clues as to why the collector isn't working. - -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on - your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. - - ```bash - cd /usr/libexec/netdata/plugins.d/ - ``` - -- Switch to the `netdata` user. - - ```bash - sudo -u netdata -s - ``` - -- Run the `go.d.plugin` to debug the collector: - - ```bash - ./go.d.plugin -d -m ntpd - ``` - - -- cgit v1.2.3