| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-ntpd |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: ntpd |
| 7 | monitored_instance: |
| 8 | name: NTPd |
| 9 | link: https://www.ntp.org/documentation/4.2.8-series/ntpd |
| 10 | icon_filename: ntp.png |
| 11 | categories: |
| 12 | - data-collection.networking |
| 13 | keywords: |
| 14 | - ntpd |
| 15 | - ntp |
| 16 | - time |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: [] |
| 20 | info_provided_to_referring_integrations: |
| 21 | description: "" |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: > |
| 25 | This collector monitors the system variables of the local `ntpd` daemon (optional incl. variables of the polled peers) |
| 26 | using the NTP Control Message Protocol via UDP socket, similar to `ntpq`, |
| 27 | the [standard NTP query program](https://doc.ntp.org/current-stable/ntpq.html). |
| 28 | method_description: "" |
| 29 | supported_platforms: |
| 30 | include: [] |
| 31 | exclude: [] |
| 32 | multi_instance: true |
| 33 | additional_permissions: |
| 34 | description: "" |
| 35 | default_behavior: |
| 36 | auto_detection: |
| 37 | description: "" |
| 38 | limits: |
| 39 | description: "" |
| 40 | performance_impact: |
| 41 | description: "" |
| 42 | setup: |
| 43 | prerequisites: |
| 44 | list: [] |
| 45 | configuration: |
| 46 | file: |
| 47 | name: go.d/ntpd.conf |
| 48 | options: |
| 49 | description: | |
| 50 | The following options can be defined globally: update_every, autodetection_retry. |
| 51 | folding: |
| 52 | title: Config options |
| 53 | enabled: true |
| 54 | list: |
| 55 | - name: update_every |
| 56 | description: Data collection interval (seconds). |
| 57 | default_value: 1 |
| 58 | required: false |
| 59 | group: Collection |
| 60 | - name: autodetection_retry |
| 61 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 62 | default_value: 0 |
| 63 | required: false |
| 64 | group: Collection |
| 65 | |
| 66 | - name: address |
| 67 | description: NTP server address (`IP:PORT`). |
| 68 | default_value: 127.0.0.1:123 |
| 69 | required: true |
| 70 | group: Target |
| 71 | - name: timeout |
| 72 | description: Connection, read, and write timeout (seconds). |
| 73 | default_value: 1 |
| 74 | required: false |
| 75 | group: Target |
| 76 | |
| 77 | - name: collect_peers |
| 78 | description: Collect peer metrics. |
| 79 | default_value: false |
| 80 | required: false |
| 81 | group: Metrics Selection |
| 82 | |
| 83 | - name: vnode |
| 84 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 85 | default_value: "" |
| 86 | required: false |
| 87 | group: Virtual Node |
| 88 | examples: |
| 89 | folding: |
| 90 | title: Config |
| 91 | enabled: true |
| 92 | list: |
| 93 | - name: Basic |
| 94 | description: A basic example configuration. |
| 95 | config: | |
| 96 | jobs: |
| 97 | - name: local |
| 98 | address: 127.0.0.1:123 |
| 99 | - name: With peers metrics |
| 100 | description: Collect peers metrics. |
| 101 | config: | |
| 102 | jobs: |
| 103 | - name: local |
| 104 | address: 127.0.0.1:123 |
| 105 | collect_peers: yes |
| 106 | - name: Multi-instance |
| 107 | description: | |
| 108 | > **Note**: When you define multiple jobs, their names must be unique. |
| 109 | |
| 110 | Collecting metrics from local and remote instances. |
| 111 | config: | |
| 112 | jobs: |
| 113 | - name: local |
| 114 | address: 127.0.0.1:123 |
| 115 | |
| 116 | - name: remote |
| 117 | address: 203.0.113.0:123 |
| 118 | troubleshooting: |
| 119 | problems: |
| 120 | list: [] |
| 121 | alerts: [] |
| 122 | metrics: |
| 123 | folding: |
| 124 | title: Metrics |
| 125 | enabled: false |
| 126 | description: "" |
| 127 | availability: [] |
| 128 | scopes: |
| 129 | - name: global |
| 130 | description: These metrics refer to the entire monitored application. |
| 131 | labels: [] |
| 132 | metrics: |
| 133 | - name: ntpd.sys_offset |
| 134 | description: Combined offset of server relative to this host |
| 135 | unit: milliseconds |
| 136 | chart_type: area |
| 137 | dimensions: |
| 138 | - name: offset |
| 139 | - name: ntpd.sys_jitter |
| 140 | description: Combined system jitter and clock jitter |
| 141 | unit: milliseconds |
| 142 | chart_type: line |
| 143 | dimensions: |
| 144 | - name: system |
| 145 | - name: clock |
| 146 | - name: ntpd.sys_frequency |
| 147 | description: Frequency offset relative to hardware clock |
| 148 | unit: ppm |
| 149 | chart_type: area |
| 150 | dimensions: |
| 151 | - name: frequency |
| 152 | - name: ntpd.sys_wander |
| 153 | description: Clock frequency wander |
| 154 | unit: ppm |
| 155 | chart_type: area |
| 156 | dimensions: |
| 157 | - name: clock |
| 158 | - name: ntpd.sys_rootdelay |
| 159 | description: Total roundtrip delay to the primary reference clock |
| 160 | unit: milliseconds |
| 161 | chart_type: area |
| 162 | dimensions: |
| 163 | - name: delay |
| 164 | - name: ntpd.sys_rootdisp |
| 165 | description: Total root dispersion to the primary reference clock |
| 166 | unit: milliseconds |
| 167 | chart_type: area |
| 168 | dimensions: |
| 169 | - name: dispersion |
| 170 | - name: ntpd.sys_stratum |
| 171 | description: Stratum |
| 172 | unit: stratum |
| 173 | chart_type: line |
| 174 | dimensions: |
| 175 | - name: stratum |
| 176 | - name: ntpd.sys_tc |
| 177 | description: Time constant and poll exponent |
| 178 | unit: log2 |
| 179 | chart_type: line |
| 180 | dimensions: |
| 181 | - name: current |
| 182 | - name: minimum |
| 183 | - name: ntpd.sys_precision |
| 184 | description: Precision |
| 185 | unit: log2 |
| 186 | chart_type: line |
| 187 | dimensions: |
| 188 | - name: precision |
| 189 | - name: peer |
| 190 | description: These metrics refer to the NTPd peer. |
| 191 | labels: |
| 192 | - name: peer_address |
| 193 | description: peer's source IP address |
| 194 | metrics: |
| 195 | - name: ntpd.peer_offset |
| 196 | description: Peer offset |
| 197 | unit: milliseconds |
| 198 | chart_type: line |
| 199 | dimensions: |
| 200 | - name: offset |
| 201 | - name: ntpd.peer_delay |
| 202 | description: Peer delay |
| 203 | unit: milliseconds |
| 204 | chart_type: line |
| 205 | dimensions: |
| 206 | - name: delay |
| 207 | - name: ntpd.peer_dispersion |
| 208 | description: Peer dispersion |
| 209 | unit: milliseconds |
| 210 | chart_type: line |
| 211 | dimensions: |
| 212 | - name: dispersion |
| 213 | - name: ntpd.peer_jitter |
| 214 | description: Peer jitter |
| 215 | unit: milliseconds |
| 216 | chart_type: line |
| 217 | dimensions: |
| 218 | - name: jitter |
| 219 | - name: ntpd.peer_xleave |
| 220 | description: Peer interleave delay |
| 221 | unit: milliseconds |
| 222 | chart_type: line |
| 223 | dimensions: |
| 224 | - name: xleave |
| 225 | - name: ntpd.peer_rootdelay |
| 226 | description: Peer roundtrip delay to the primary reference clock |
| 227 | unit: milliseconds |
| 228 | chart_type: line |
| 229 | dimensions: |
| 230 | - name: rootdelay |
| 231 | - name: ntpd.peer_rootdisp |
| 232 | description: Peer root dispersion to the primary reference clock |
| 233 | unit: milliseconds |
| 234 | chart_type: line |
| 235 | dimensions: |
| 236 | - name: dispersion |
| 237 | - name: ntpd.peer_stratum |
| 238 | description: Peer stratum |
| 239 | unit: stratum |
| 240 | chart_type: line |
| 241 | dimensions: |
| 242 | - name: stratum |
| 243 | - name: ntpd.peer_hmode |
| 244 | description: Peer host mode |
| 245 | unit: hmode |
| 246 | chart_type: line |
| 247 | dimensions: |
| 248 | - name: hmode |
| 249 | - name: ntpd.peer_pmode |
| 250 | description: Peer mode |
| 251 | unit: pmode |
| 252 | chart_type: line |
| 253 | dimensions: |
| 254 | - name: pmode |
| 255 | - name: ntpd.peer_hpoll |
| 256 | description: Peer host poll exponent |
| 257 | unit: log2 |
| 258 | chart_type: line |
| 259 | dimensions: |
| 260 | - name: hpoll |
| 261 | - name: ntpd.peer_ppoll |
| 262 | description: Peer poll exponent |
| 263 | unit: log2 |
| 264 | chart_type: line |
| 265 | dimensions: |
| 266 | - name: ppoll |
| 267 | - name: ntpd.peer_precision |
| 268 | description: Peer precision |
| 269 | unit: log2 |
| 270 | chart_type: line |
| 271 | dimensions: |
| 272 | - name: precision |