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