1ntp_mon(5) File Formats Manual ntp_mon(5)
2
6 ntp_mon - Monitoring Options
7 ntpd includes a comprehensive monitoring facility suitable for continu‐
10 ous, long term recording of server and client timekeeping performance.
11 See the statistics command below for a listing and example of each type
12 of statistics currently supported. Statistic files are managed using
13 file generation sets and scripts in the ./scripts directory of this
14 distribution. Using these facilities and Unix cron jobs, the datacan be
15 automatically summarized and archived for retrospective analysis.
16
19 statistics name [...]
20 Enables writing of statistics records. Currently, six kinds of
21 namestatistics are supported.
22 clockstats
24 Enables recording of clock driver statistics informa‐
25 tion. Each update received from a clock driver appends
26 a line of the following form to the file generation set
27 named clockstats: 49213 525.624 127.127.4.1 93 226
28 00:08:29.606 D The first two fields show the date (Mod‐
29 ified Julian Day) and time (seconds and fraction past
30 UTC midnight). The next field shows the clock address
31 in dotted-quad notation, The final field shows the last
32 timecode received from the clock in decoded ASCII for‐
33 mat, where meaningful. In some clock drivers a good
34 deal of additional information can be gathered and dis‐
35 played as well. See information specific to each clock
36 for further details.
37 cryptostats
39 This option requires the OpenSSL cryptographic software
40 library. It enables recording of cryptographic public
41 key protocol information. Each message received by the
42 protocol module appends a line of the following form to
43 the file generation set named cryptostats: 49213
44 525.624 127.127.4.1 message The first two fields show
45 the date (Modified Julian Day) and time (seconds and
46 fraction past UTC midnight). The next field shows the
47 peer address in dotted-quad notation, The final message
48 field includes the message type and certain ancillary
49 information. See the Authentication Options page for
50 further information.
51 loopstats
53 Enables recording of loop filter statistics informa‐
54 tion. Each update of the local clock outputs a line of
55 the following form to the file generation set named
56 loopstats: 50935 75440.031 0.000006019 13.778190
57 0.000351733 0.0133806 6 The first two fields show the
58 date (Modified Julian Day) and time (seconds and frac‐
59 tion past UTC midnight). The next five fields show time
60 offset (seconds), frequency offset (parts per million -
61 PPM), RMS jitter (seconds), Allan deviation (PPM) and
62 clock discipline time constant.
63 peerstats
65 Enables recording of peer statistics information. This
66 includes statistics records of all peers of a NTP
67 server and of special signals, where present and con‐
68 figured. Each valid update appends a line of the fol‐
69 lowing form to the current element of a file generation
70 set named peerstats:
71 48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000
73 0.001424877 0.000958674
74 The first two fields show the date (Modified Julian
75 Day) and time (seconds and fraction past UTC midnight).
76 The next two fields show the peer address in dotted-
77 quad notation and status, respectively. The status
78 field is encoded in hex in the format described in Ap‐
79 pendix B of the NTP specification RFC 1305. The final
80 four fields show the offset, delay, dispersion and RMS
81 jitter, all in seconds.
82 rawstats
84 Enables recording of raw-timestamp statistics informa‐
85 tion. This includes statistics records of all peers of
86 a NTP server and of special signals, where present and
87 configured. Each NTP message received from a peer or
88 clock driver appends a line of the following form to
89 the file generation set named rawstats:
90 50928 2132.543 128.4.1.1 128.4.1.20 3102453281.584327000
92 3102453281.58622800031 02453332.540806000 3102453332.541458000
93 The first two fields show the date (Modified Julian
94 Day) and time (seconds and fraction past UTC midnight).
95 The next two fields show the remote peer or clock
96 address followed by the local address in dotted-quad
97 notation, The final four fields show the originate,
98 receive, transmit and final NTP timestamps in order.
99 The timestamp values are as received and before pro‐
100 cessing by the various data smoothing and mitigation
101 algorithms.
102 sysstats
104 Enables recording of ntpd statistics counters on a
105 periodic basis. Each hour a line of the following form
106 is appended to the file generation set named sysstats:
107 50928 2132.543 36000 81965 0 9546 56 71793 512 540 10
108 147 The first two fields show the date (Modified Julian
109 Day) and time (seconds and fraction past UTC midnight).
110 The remaining ten fields show the statistics counter
111 values accumulated since the last generated line.
112 Time since restart 36000
114 Time in hours since the system was last
115 rebooted.
116 Packets received 81965
118 Total number of packets received.
119 Packets processed 0
121 Number of packets received in response to pre‐
122 vious packets sent
123 Current version 9546
125 Number of packets matching the current NTP ver‐
126 sion.
127 Previous version 56
129 Number of packets matching the previous NTP
130 version.
131 Bad version 71793
133 Number of packets matching neither NTP version.
134 Access denied 512
136 Number of packets denied access for any reason.
137 Bad length or format 540
139 Number of packets with invalid length, format
140 or port number.
141 Bad authentication 10
143 Number of packets not verified as authentic.
144 Rate exceeded 147
146 Number of packets discarded due to rate limita‐
147 tion.
148 timingstats
151 ONLY available when the deamon is compiled with process
152 time debugging support (--enable-debug-timing - costs
153 performance). Enables recording of ntpd processing time
154 information for various selected code paths: 53876
155 36.920 10.0.3.5 1 0.000014592 input processing delay
156 The first two fields show the date (Modified Julian
157 Day) and time (seconds and fraction past UTC midnight).
158 The next field is a potential peer address, - or -REF‐
159 CLOCK- depending on the associated io source. Then an
160 event count for the number of processed events in the
161 code path follows. The fifth field is the total time
162 spend for the events. The rest of the line denotes the
163 code path description (see source for more informa‐
164 tion).
165 statsdir directory_path
167 Indicates the full path of a directory where statistics
168 files should be created (see below). This keyword
169 allows the (otherwise constant) filegen filename prefix
170 to be modified for file generation sets, which is use‐
171 ful for handling statistics logs.
172 filegen name [file filename] [type typename] [link | nolink]
174 [enable | disable]
175 Configures setting of generation file set name. Genera‐
176 tion file sets provide a means for handling files that
177 are continuously growing during the lifetime of a
178 server. Server statistics are a typical example for
179 such files. Generation file sets provide access to a
180 set of files used to store the actual data. At any time
181 at most one element of the set is being written to. The
182 type given specifies when and how data will be directed
183 to a new element of the set. This way, information
184 stored in elements of a file set that are currently
185 unused are available for administrational operations
186 without the risk of disturbing the operation of ntpd.
187 (Most important: they can be removed to free space for
188 new data produced.) Note that this command can be sent
189 from the ntpdc program running at a remote location.
190 name This is the type of the statistics records, as
192 shown in the statistics command.
193 file filename
195 This is the file name for the statistics
196 records. Filenames of set members are built
197 from three concatenated elements prefix, file‐
198 name and suffix:
199 prefix This is a constant filename path. It is
201 not subject to modifications via the
202 filegen option. It is defined by the
203 server, usually specified as a compile-
204 time constant. It may, however, be con‐
205 figurable for individual file genera‐
206 tion sets via other commands. For exam‐
207 ple, the prefix used with loopstats and
208 peerstats generation can be configured
209 using the statsdir option explained
210 above.
211 filename
213 This string is directly concatenated to
214 the prefix mentioned above (no inter‐
215 vening / (slash)). This can be modified
216 using the file argument to the filegen
217 statement. No .. elements are allowed
218 in this component to prevent filenames
219 referring to parts outside the filesys‐
220 tem hierarchy denoted by prefix.
221 suffix This part is reflects individual ele‐
223 ments of a file set. It is generated
224 according to the type of a file set.
225 type typename
228 A file generation set is characterized by its
229 type. The following types are supported:
230 none The file set is actually a single plain
232 file.
233 pid One element of file set is used per
235 incarnation of a ntpd server. This type
236 does not perform any changes to file
237 set members during runtime, however it
238 provides an easy way of separating
239 files belonging to different ntpd
240 server incarnations. The set member
241 filename is built by appending a .
242 (dot) to concatenated prefix and file‐
243 name strings, and appending the decimal
244 representation of the process ID of the
245 ntpd server process.
246 day One file generation set element is cre‐
248 ated per day. A day is defined as the
249 period between 00:00 and 24:00 UTC. The
250 file set member suffix consists of a .
251 (dot) and a day specification in the
252 form YYYYMMdd. YYYY is a 4-digit year
253 number (e.g., 1992). MM is a two digit
254 month number. dd is a two digit day
255 number. Thus, all information written
256 at 10 December 1992 would end up in a
257 file named prefix filename.19921210.
258 week Any file set member contains data
260 related to a certain week of a year.
261 The term week is defined by computing
262 day-of-year modulo 7. Elements of such
263 a file generation set are distinguished
264 by appending the following suffix to
265 the file set filename base: A dot, a
266 4-digit year number, the letter W, and
267 a 2-digit week number. For example,
268 information from January, 10th 1992
269 would end up in a file with suffix
270 .1992W1.
271 month One generation file set element is gen‐
273 erated per month. The file name suffix
274 consists of a dot, a 4-digit year num‐
275 ber, and a 2-digit month.
276 year One generation file element is gener‐
278 ated per year. The filename suffix con‐
279 sists of a dot and a 4 digit year num‐
280 ber.
281 age This type of file generation sets
283 changes to a new element of the file
284 set every 24 hours of server operation.
285 The filename suffix consists of a dot,
286 the letter a, and an 8-digit number.
287 This number is taken to be the number
288 of seconds the server is running at the
289 start of the corresponding 24-hour
290 period. Information is only written to
291 a file generation by specifying enable;
292 output is prevented by specifying dis‐
293 able.
294 link | nolink
297 It is convenient to be able to access the cur‐
298 rent element of a file generation set by a
299 fixed name. This feature is enabled by specify‐
300 ing link and disabled using nolink. If link is
301 specified, a hard link from the current file
302 set element to a file without suffix is cre‐
303 ated. When there is already a file with this
304 name and the number of links of this file is
305 one, it is renamed appending a dot, the letter
306 C, and the pid of the ntpd server process. When
307 the number of links is greater than one, the
308 file is unlinked. This allows the current file
309 to be accessed by a constant name.
310 enable | disable
312 Enables or disables the recording function.
313
318 ntp.conf(5)
319 Primary source of documentation: /usr/share/doc/ntp-*
321 This file was automatically generated from HTML source.
323 ntp_mon(5)