1ntp_mon(5) File Formats Manual ntp_mon(5)
2
6 ntp_mon - Monitoring Options
7
10 The ntpd includes a comprehensive monitoring facility which collects
11 statistical data of various types and writes the data to files associ‐
12 ated with each type at defined events or intervals. The files associ‐
13 ated with a particular type are collectively called the generation file
14 set for that type. The files in the file set are the members of that
15 set.
16 File sets have names specific to the type and generation epoch. The
18 names are constructed from three concatenated elements prefix, filename
19 and suffix:
20 prefix The directory path specified in the statsdir command.
23 name The name specified by the file option of the filegen command.
25 suffix A string of elements bdginning with . (dot) followed by a num‐
27 ber of elements depending on the file set type.
28 Statistics files can be managed using scripts, examples of which are in
30 the ./scripts directory. Using these or similar scripts and Unix cron
31 jobs, the files can be automatically summarized and archived for retro‐
32 spective analysis.
33
36 filegen name file filename [type type] [link | nolink] [enable | dis‐
37 able]
38 name Specifies the file set type from the list in the next
41 section.
42 file filename
44 Specfies the file set name.
45 type typename
47 Specifies the file set interval. The following inter‐
48 vals are supported with default day:
49 none The file set is actually a single plain file.
52 pid One file set member is created for every incar‐
54 nation of ntpd. The file name suffix is the
55 string .n, where n is the process ID of the
56 ntpd server process.
57 day One file set member is created per day. A day
59 is defined as the period between 00:00 and
60 23:59 UTC. The file name suffix is the string
61 .yyyymmdd, where yyyy is the year, mm the month
62 of the year and dd the day of the month. Thus,
63 member created on 10 December 1992 would have
64 suffix .19921210.
65 week One file set member is created per week. The
67 week is defined as the day of year modulo 7.
68 The file name suffix is the string .yyyyWww,
69 where yyyy is the year, W stands for itself and
70 ww the week number starting from 0. For exam‐
71 ple, The member created on 10 January 1992
72 would have suffix .1992W1.
73 month One file set member is created per month. The
75 file name suffix is the string .yyyymm, where
76 yyyy is the year and mm the month of the year
77 starting from 1. For example, The member cre‐
78 ated on 10 January 1992 would have suffix
79 .199201.
80 year One file set member is generated per year. The
82 file name suffix is the string .yyyy, where
83 yyyy is the year. For example, The member cre‐
84 ated on 1 January 1992 would have suffix .1992.
85 age One file set member is generated every 24 hours
87 of ntpd operation. The filename suffix is the
88 string .adddddddd, where a stands for itself
89 and dddddddd is the ntpd running time in sec‐
90 onds at the start of the corresponding 24-hour
91 period.
92 link | nolink
95 It is convenient to be able to access the current file
96 set members by file name, but without the suffix. This
97 feature is enabled by link and disabled by nolink. If
98 enabled, which is the default, a hard link from the
99 current file set member to a file without suffix is
100 created. When there is already a file with this name
101 and the number of links to this file is one, it is
102 renamed by appending a dot, the letter C, and the pid
103 of the ntpd server process. When the number of links is
104 greater than one, the file is unlinked. This allows the
105 current file to be accessed by a constant name.
106 enable | disable
108 Enable or disable the recording function, with default
109 enable. These options are intended for remote con‐
110 figutation commands.
111 statsdir directory_path
114 Specify the directory path prefix for statistics file names.
115
118 clockstats
119 Record reference clock statistics. Each update received from a
120 reference clock driver appends one line to the clockstats file
121 set: 49213 525.624 127.127.4.1 93 226 00:08:29.606 D
122 ┌─────────────────┬──────────────┬─────────────────────────────┐
125 │ Item │ Units │ Description │
126 ├─────────────────┼──────────────┼─────────────────────────────┤
127 │ 49213 │ MJD │ date │
128 ├─────────────────┼──────────────┼─────────────────────────────┤
129 │ 525.624 │ s │ time past midnight │
130 ├─────────────────┼──────────────┼─────────────────────────────┤
131 │ 127.127.4.1 │ IP │ reference clock address │
132 ├─────────────────┼──────────────┼─────────────────────────────┤
133 │ message │ text │ log message │
134 └─────────────────┴──────────────┴─────────────────────────────┘
135 The message field includes the last timecode received in
136 decoded ASCII format, where meaningful. In some cases a good
137 deal of additional information is displayed. See information
138 specific to each reference clock for further details.
139 cryptostats
141 Record significant events in the Autokey protocol. This option
142 requires the OpenSSL cryptographic software library. Each event
143 appends one line to the cryptostats file set: 49213 525.624
144 128.4.1.1 message
145 ┌────────────┬──────────┬──────────────────────────────────────┐
148 │Item │ Units │ Description │
149 ├────────────┼──────────┼──────────────────────────────────────┤
150 │49213 │ MJD │ date │
151 ├────────────┼──────────┼──────────────────────────────────────┤
152 │525.624 │ s │ time past midnight │
153 ├────────────┼──────────┼──────────────────────────────────────┤
154 │128.4.1.1 │ IP │ source address (0.0.0.0 for system) │
155 ├────────────┼──────────┼──────────────────────────────────────┤
156 │message │ text │ log message │
157 └────────────┴──────────┴──────────────────────────────────────┘
158 The message field includes the message type and certain ancil‐
159 lary information. See the Authentication Options page for fur‐
160 ther information.
161 loopstats
163 Record clock discipline loop statistics. Each system clock
164 update appends one line to the loopstats file set: 50935
165 75440.031 0.000006019 13.778 0.000351733 0.013380 6
166 ┌─────────────┬──────────┬─────────────────────────────────────┐
169 │Item │ Units │ Description │
170 ├─────────────┼──────────┼─────────────────────────────────────┤
171 │50935 │ MJD │ date │
172 ├─────────────┼──────────┼─────────────────────────────────────┤
173 │75440.031 │ s │ time past midnight │
174 ├─────────────┼──────────┼─────────────────────────────────────┤
175 │0.000006019 │ s │ clock offset │
176 ├─────────────┼──────────┼─────────────────────────────────────┤
177 │13.778 │ PPM │ frequency offset │
178 ├─────────────┼──────────┼─────────────────────────────────────┤
179 │0.000351733 │ s │ RMS jitter │
180 ├─────────────┼──────────┼─────────────────────────────────────┤
181 │0.013380 │ PPM │ RMS frequency jitter (aka wander) │
182 ├─────────────┼──────────┼─────────────────────────────────────┤
183 │6 │ log2 s │ clock discipline loop time constant │
184 └─────────────┴──────────┴─────────────────────────────────────┘
185 peerstats
187 Record peer statistics. Each NTP packet or reference clock
188 update received appends one line to the peerstats file set:
189 48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000
190 0.001424877 0.000958674
191 ┌───────────────────┬───────────────┬──────────────────────────┐
194 │ Item │ Units │ Description │
195 ├───────────────────┼───────────────┼──────────────────────────┤
196 │ 48773 │ MJD │ date │
197 ├───────────────────┼───────────────┼──────────────────────────┤
198 │ 10847.650 │ s │ time past midnight │
199 ├───────────────────┼───────────────┼──────────────────────────┤
200 │ 127.127.4.1 │ IP │ source address │
201 ├───────────────────┼───────────────┼──────────────────────────┤
202 │ 9714 │ hex │ status word │
203 ├───────────────────┼───────────────┼──────────────────────────┤
204 │ -0.001605376 │ s │ clock offset │
205 ├───────────────────┼───────────────┼──────────────────────────┤
206 │ 0.000000000 │ s │ roundtrip delay │
207 ├───────────────────┼───────────────┼──────────────────────────┤
208 │ 0.001424877 │ s │ dispersion │
209 ├───────────────────┼───────────────┼──────────────────────────┤
210 │ 0.000958674 │ s │ RMS jitter │
211 └───────────────────┴───────────────┴──────────────────────────┘
212 The status field is encoded in hex format as described in Ap‐
213 pendix B of the NTP specification RFC 1305.
214 protostats
216 Record significant peer, system and [rptpcp; events. Each sig‐
217 nificant event appends one line to the protostats file set:
218 49213 525.624 128.4.1.1 963a 8a message
219 ┌────────────┬──────────┬──────────────────────────────────────┐
222 │Item │ Units │ Description │
223 ├────────────┼──────────┼──────────────────────────────────────┤
224 │49213 │ MJD │ date │
225 ├────────────┼──────────┼──────────────────────────────────────┤
226 │525.624 │ s │ time past midnight │
227 ├────────────┼──────────┼──────────────────────────────────────┤
228 │128.4.1.1 │ IP │ source address (0.0.0.0 for system) │
229 ├────────────┼──────────┼──────────────────────────────────────┤
230 │963a │ code │ status word │
231 ├────────────┼──────────┼──────────────────────────────────────┤
232 │8a │ code │ event message code │
233 ├────────────┼──────────┼──────────────────────────────────────┤
234 │message │ text │ event message │
235 └────────────┴──────────┴──────────────────────────────────────┘
236 The event message code and message field are described on the
237 Event Messages and Status Words page.
238 rawstats
240 Record timestamp statistics. Each NTP packet received appends
241 one line to the rawstats file set: 50928 2132.543 128.4.1.1
242 128.4.1.20 3102453281.584327000 3102453281.58622800031
243 02453332.540806000 3102453332.541458000
244 ┌─────────────────────────┬──────────┬─────────────────────────┐
247 │Item │ Units │ Description │
248 ├─────────────────────────┼──────────┼─────────────────────────┤
249 │50928 │ MJD │ date │
250 ├─────────────────────────┼──────────┼─────────────────────────┤
251 │2132.543 │ s │ time past midnight │
252 ├─────────────────────────┼──────────┼─────────────────────────┤
253 │128.4.1.1 │ IP │ source address │
254 ├─────────────────────────┼──────────┼─────────────────────────┤
255 │128.4.1.20 │ IP │ destination address │
256 ├─────────────────────────┼──────────┼─────────────────────────┤
257 │3102453281.584327000 │ NTP s │ origin timestamp │
258 ├─────────────────────────┼──────────┼─────────────────────────┤
259 │3102453281.586228000 │ NTP s │ receive timestamp │
260 ├─────────────────────────┼──────────┼─────────────────────────┤
261 │3102453332.540806000 │ NTP s │ transmit timestamp │
262 ├─────────────────────────┼──────────┼─────────────────────────┤
263 │3102453332.541458000 │ NTP s │ destination timestamp │
264 └─────────────────────────┴──────────┴─────────────────────────┘
265 sysstats
267 Record system statistics. Each hour one line is appended to the
268 sysstats file set in the following format: 50928 2132.543 3600
269 81965 0 9546 56 512 540 10 4 147 1
270 ┌──────────────┬──────────────┬────────────────────────────────┐
273 │ Item │ Units │ Description │
274 ├──────────────┼──────────────┼────────────────────────────────┤
275 │ 50928 │ MJD │ date │
276 ├──────────────┼──────────────┼────────────────────────────────┤
277 │ 2132.543 │ s │ time past midnight │
278 ├──────────────┼──────────────┼────────────────────────────────┤
279 │ 3600 │ s │ time since reset │
280 ├──────────────┼──────────────┼────────────────────────────────┤
281 │ 81965 │ # │ packets received │
282 ├──────────────┼──────────────┼────────────────────────────────┤
283 │ 0 │ # │ packets for this host │
284 ├──────────────┼──────────────┼────────────────────────────────┤
285 │ 9546 │ # │ current versions │
286 ├──────────────┼──────────────┼────────────────────────────────┤
287 │ 56 │ # │ old version │
288 ├──────────────┼──────────────┼────────────────────────────────┤
289 │ 512 │ # │ access denied │
290 ├──────────────┼──────────────┼────────────────────────────────┤
291 │ 540 │ # │ bad length or format │
292 ├──────────────┼──────────────┼────────────────────────────────┤
293 │ 10 │ # │ bad authentication │
294 ├──────────────┼──────────────┼────────────────────────────────┤
295 │ 4 │ # │ declined │
296 ├──────────────┼──────────────┼────────────────────────────────┤
297 │ 147 │ # │ rate exceeded │
298 ├──────────────┼──────────────┼────────────────────────────────┤
299 │ 1 │ # │ kiss-o'-death packets sent │
300 └──────────────┴──────────────┴────────────────────────────────┘
301 timingstats
303 (Only available when the deamon is compiled with process time
304 debugging support (--enable-debug-timing - costs performance).
305 Record processing time statistics for various selected code
306 paths. 53876 36.920 10.0.3.5 1 0.000014592 input processing
307 delay
308 ┌──────────────┬─────────┬─────────────────────────────────────┐
311 │Item │ Units │ Description │
312 ├──────────────┼─────────┼─────────────────────────────────────┤
313 │53876 │ MJD │ date │
314 ├──────────────┼─────────┼─────────────────────────────────────┤
315 │36.920 │ s │ time past midnight │
316 ├──────────────┼─────────┼─────────────────────────────────────┤
317 │10.0.3.5 │ IP │ server address │
318 ├──────────────┼─────────┼─────────────────────────────────────┤
319 │1 │ # │ event count │
320 ├──────────────┼─────────┼─────────────────────────────────────┤
321 │0.000014592 │ s │ total time │
322 ├──────────────┼─────────┼─────────────────────────────────────┤
323 │message │ text │ code path description (see source) │
324 └──────────────┴─────────┴─────────────────────────────────────┘
325
328 ntp.conf(5), ntp_decode(5)
329 The official HTML documentation.
331 This file was automatically generated from HTML source.
333 ntp_mon(5)