xref: /freebsd/contrib/ntp/html/monopt.html (revision 091002585974d17c9533f943ec351c13a69788ab)
19c2daa00SOllivier Robert<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
29c2daa00SOllivier Robert<html>
39c2daa00SOllivier Robert<head>
4ea906c41SOllivier Robert<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
59c2daa00SOllivier Robert<meta name="generator" content="HTML Tidy, see www.w3.org">
69c2daa00SOllivier Robert<title>Monitoring Options</title>
79c2daa00SOllivier Robert<link href="scripts/style.css" type="text/css" rel="stylesheet">
89c2daa00SOllivier Robert</head>
99c2daa00SOllivier Robert<body>
102b15cb3dSCy Schubert<h3>Monitoring Commands and Options</h3>
112b15cb3dSCy Schubert<img src="pic/pogo8.gif" alt="gif" align="left"><a href="http://www.eecis.udel.edu/~mills/pictures.html"></a> from <i>Pogo</i>, Walt Kelly</a>
122b15cb3dSCy Schubert<p>Pig was hired to watch the logs.</p>
132b15cb3dSCy Schubert<p>Last update:
14*09100258SXin LI  <!-- #BeginDate format:En2m -->7-Dec-2017  10:17<!-- #EndDate -->
152b15cb3dSCy Schubert    UTC</p>
169c2daa00SOllivier Robert<br clear="left">
179c2daa00SOllivier Robert<h4>Related Links</h4>
182b15cb3dSCy Schubert<script type="text/javascript" language="javascript" src="scripts/command.txt"></script>
192b15cb3dSCy Schubert<script type="text/javascript" language="javascript" src="scripts/monopt.txt"></script>
202b15cb3dSCy Schubert<h4>Table of Contents</h4>
212b15cb3dSCy Schubert<ul>
222b15cb3dSCy Schubert  <li class="inline"><a href="#intro">Naming Conventions</a></li>
232b15cb3dSCy Schubert  <li class="inline"><a href="#cmd">Monitoring Commands and Options</a></li>
242b15cb3dSCy Schubert  <li class="inline"><a href="#types">File Set Types</a></li>
252b15cb3dSCy Schubert</ul>
269c2daa00SOllivier Robert<hr>
272b15cb3dSCy Schubert<h4 id="intro">Naming Conventions</h4>
282b15cb3dSCy Schubert<p>The <tt>ntpd</tt> includes a comprehensive monitoring facility which collects
292b15cb3dSCy Schubert  statistical data of various types and writes the data to files associated with
302b15cb3dSCy Schubert  each type at defined events or intervals. The files associated with a particular
312b15cb3dSCy Schubert  type are collectively called the generation file set for that type. The files
322b15cb3dSCy Schubert  in the file set are the members of that set.</p>
332b15cb3dSCy Schubert<p>File sets have names specific to the type and generation epoch. The names
342b15cb3dSCy Schubert  are constructed from three concatenated elements <i><tt>prefix</tt></i>, <i><tt>filename</tt></i> and <i><tt>suffix</tt></i>:</p>
359c2daa00SOllivier Robert<dl>
362b15cb3dSCy Schubert  <dt><i><tt>prefix</tt></i></dt>
372b15cb3dSCy Schubert  <dd>The directory path specified in the <tt>statsdir</tt> command.</dd>
382b15cb3dSCy Schubert  <dt><i><tt>name</tt></i></dt>
392b15cb3dSCy Schubert  <dd>The name specified by the <tt>file</tt> option of the <tt>filegen</tt> command.</dd>
402b15cb3dSCy Schubert  <dt><i><tt>suffix</tt></i></dt>
412b15cb3dSCy Schubert  <dd>A string of elements bdginning with . (dot) followed by a number of elements
422b15cb3dSCy Schubert    depending on the file set type.</dd>
439c2daa00SOllivier Robert</dl>
442b15cb3dSCy Schubert<p>Statistics files can be managed using scripts, examples of which are in the <tt>./scripts</tt> directory.
452b15cb3dSCy Schubert  Using these or similar scripts and Unix <tt>cron</tt> jobs, the files can be
462b15cb3dSCy Schubert  automatically summarized and archived for retrospective analysis.</p>
472b15cb3dSCy Schubert<h4 id="cmd">Monitoring Commands and Options</h4>
482b15cb3dSCy Schubert<p>Unless noted otherwise, further information about these commands is on the <a href="decode.html">Event Messages and Status Codes</a> page.</p></a> page.</p><dl>
492b15cb3dSCy Schubert  <dt id="filegen"><tt>filegen <i>name</i> [file <i>filename</i>] [type <i>type</i>]
502b15cb3dSCy Schubert    [link | nolink] [enable | disable]</tt></dt>
512b15cb3dSCy Schubert  <dd>
529c2daa00SOllivier Robert    <dl>
532b15cb3dSCy Schubert      <dt><i><tt>name</tt></i></dt>
542b15cb3dSCy Schubert      <dd>Specifies the file set type from the list in the next section.</dd>
552b15cb3dSCy Schubert      <dt><tt>file <i>filename</i></tt></dt>
562b15cb3dSCy Schubert      <dd>Specifies the filename prefix. The default is the file set type, such as "loopstats".</dd>
572b15cb3dSCy Schubert      <dt><tt>type <i>typename</i></tt></dt>
582b15cb3dSCy Schubert      <dd>Specifies the file set interval. The following intervals are supported
592b15cb3dSCy Schubert        with default <tt>day</tt>:</dd>
602b15cb3dSCy Schubert      <dd>
619c2daa00SOllivier Robert        <dl>
622b15cb3dSCy Schubert          <dt><tt>none</tt></dt>
632b15cb3dSCy Schubert          <dd>The file set is actually a single plain file.</dd>
642b15cb3dSCy Schubert          <dt><tt>pid</tt></dt>
652b15cb3dSCy Schubert          <dd>One file set member is created for every incarnation of <tt>ntpd</tt>.
662b15cb3dSCy Schubert            The file name suffix is the string .<tt>n</tt>, where <tt>n</tt> is the
672b15cb3dSCy Schubert            process ID of the <tt>ntpd</tt> server process.</dd>
682b15cb3dSCy Schubert          <dt><tt>day</tt></dt>
692b15cb3dSCy Schubert          <dd>One file set member is created per day. A day is defined as the period
702b15cb3dSCy Schubert            between 00:00 and 23:59 UTC. The file name suffix is the string .<tt>yyyymmdd</tt>,
712b15cb3dSCy Schubert            where <tt>yyyy</tt> is the year, <tt>mm</tt> the month of the year and <tt>dd</tt> the
722b15cb3dSCy Schubert            day of the month. Thus, member created on 10 December 1992 would have suffix <tt>.19921210</tt>.</dd>
732b15cb3dSCy Schubert          <dt><tt>week</tt></dt>
742b15cb3dSCy Schubert          <dd>One file set member is created per week. The week is defined as the
752b15cb3dSCy Schubert            day of year modulo 7. The file name suffix is the string .<tt>yyyyWww</tt>,
762b15cb3dSCy Schubert            where <tt>yyyy</tt> is the year, <tt>W</tt> stands for itself and <tt>ww</tt> the
772b15cb3dSCy Schubert            week number starting from 0. For example, The member created on 10 January
782b15cb3dSCy Schubert            1992 would have suffix <tt>.1992W1</tt>.</dd>
792b15cb3dSCy Schubert          <dt><tt>month</tt></dt>
802b15cb3dSCy Schubert          <dd>One file set member is created per month. The file name suffix is the
812b15cb3dSCy Schubert            string .<tt>yyyymm</tt>, where <tt>yyyy</tt> is the year and <tt>mm</tt> the
822b15cb3dSCy Schubert            month of the year starting from 1. For example, The member created on 10
832b15cb3dSCy Schubert            January 1992 would have suffix <tt>.199201</tt>.</dd>
842b15cb3dSCy Schubert          <dt><tt>year</tt></dt>
852b15cb3dSCy Schubert          <dd>One file set member is generated per year. The file name suffix is the
862b15cb3dSCy Schubert            string .<tt>yyyy</tt>, where <tt>yyyy</tt> is the year. For example, The
872b15cb3dSCy Schubert            member created on 1 January 1992 would have suffix <tt>.1992</tt>.</dd>
882b15cb3dSCy Schubert          <dt><tt>age</tt></dt>
892b15cb3dSCy Schubert          <dd>One file set member is generated every 24 hours of <tt>ntpd</tt> operation.
902b15cb3dSCy Schubert            The filename suffix is the string <tt>.adddddddd</tt>, where <tt>a</tt> stands
912b15cb3dSCy Schubert            for itself and <tt>dddddddd</tt> is the <tt>ntpd</tt> running time in seconds
922b15cb3dSCy Schubert            at the start of the corresponding 24-hour period.</dd>
932b15cb3dSCy Schubert        </dl>
942b15cb3dSCy Schubert      </dd>
952b15cb3dSCy Schubert      <dt><tt>link | nolink</tt></dt>
962b15cb3dSCy Schubert      <dd>It is convenient to be able to access the current file set members by
972b15cb3dSCy Schubert        file name, but without the suffix. This feature is enabled by <tt>link</tt> and
982b15cb3dSCy Schubert        disabled by <tt>nolink</tt>. If enabled, which is the default, a hard link
992b15cb3dSCy Schubert        from the current file set member to a file without suffix is created. When
1002b15cb3dSCy Schubert        there is already a file with this name and the number of links to this file
1012b15cb3dSCy Schubert        is one, it is renamed by appending a dot, the letter <tt>C</tt>, and the
1022b15cb3dSCy Schubert        pid of the <tt>ntpd</tt> server process. When the number of links is greater
1032b15cb3dSCy Schubert        than one, the file is unlinked. This allows the current file to be accessed
1042b15cb3dSCy Schubert        by a constant name.</dd>
1052b15cb3dSCy Schubert      <dt><tt>enable | disable</tt></dt>
1062b15cb3dSCy Schubert      <dd>Enable or disable the recording function, with default <tt>enable</tt>.
1072b15cb3dSCy Schubert        These options are intended for remote configuration commands.</dd>
1082b15cb3dSCy Schubert    </dl>
1092b15cb3dSCy Schubert  </dd>
1102b15cb3dSCy Schubert  <dt id="statistics"><tt>statistics <i>name</i>...</tt></dt>
1112b15cb3dSCy Schubert  <dd>Enables writing of statistics records. Currently, eight kinds of
1122b15cb3dSCy Schubert    statistics are supported: <i>name</i>s specify the file set type(s) from
1132b15cb3dSCy Schubert    the list in the next section.</dd>
1142b15cb3dSCy Schubert  <dt id="statsdir"><tt>statsdir <i>directory_path</i></tt></dt>
1152b15cb3dSCy Schubert  <dd>Specify the directory path prefix for statistics file names.</dd>
1162b15cb3dSCy Schubert</dl>
1172b15cb3dSCy Schubert<h4 id="types">File Set Types</h4>
1189c2daa00SOllivier Robert<dl>
1192b15cb3dSCy Schubert  <dt><tt>clockstats</tt></dt>
1202b15cb3dSCy Schubert  <dd>Record reference clock statistics. Each update received from a reference
1212b15cb3dSCy Schubert    clock driver appends one line to the <tt>clockstats</tt> file set:</dd>
1222b15cb3dSCy Schubert  <dd><tt>49213 525.624 127.127.4.1 93 226 00:08:29.606 D</tt></dd>
1232b15cb3dSCy Schubert  <dd>
1242b15cb3dSCy Schubert    <table width="100%" border="1" cellspacing="2" cellpadding="2">
1252b15cb3dSCy Schubert      <tr>
1262b15cb3dSCy Schubert        <td>Item</td>
1272b15cb3dSCy Schubert        <td>Units</td>
1282b15cb3dSCy Schubert        <td>Description</td>
1292b15cb3dSCy Schubert      </tr>
1302b15cb3dSCy Schubert      <tr>
1312b15cb3dSCy Schubert        <td><tt>49213</tt></td>
1322b15cb3dSCy Schubert        <td>MJD</td>
1332b15cb3dSCy Schubert        <td>date</td>
1342b15cb3dSCy Schubert      </tr>
1352b15cb3dSCy Schubert      <tr>
1362b15cb3dSCy Schubert        <td><tt>525.624</tt></td>
1372b15cb3dSCy Schubert        <td>s</td>
1382b15cb3dSCy Schubert        <td>time past midnight</td>
1392b15cb3dSCy Schubert      </tr>
1402b15cb3dSCy Schubert      <tr>
1412b15cb3dSCy Schubert        <td><tt>127.127.4.1</tt></td>
1422b15cb3dSCy Schubert        <td>IP</td>
1432b15cb3dSCy Schubert        <td>reference clock address</td>
1442b15cb3dSCy Schubert      </tr>
1452b15cb3dSCy Schubert      <tr>
1462b15cb3dSCy Schubert        <td><tt><i>message</i></tt></td>
1472b15cb3dSCy Schubert        <td>text</td>
1482b15cb3dSCy Schubert        <td>log message</td>
1492b15cb3dSCy Schubert      </tr>
1502b15cb3dSCy Schubert    </table>
1512b15cb3dSCy Schubert  </dd>
1522b15cb3dSCy Schubert  <dd>The <tt><i>message</i></tt> field includes the last timecode received in
1532b15cb3dSCy Schubert    decoded ASCII format, where meaningful. In some cases a good deal of additional
1542b15cb3dSCy Schubert    information is displayed. See information specific to each reference clock
1552b15cb3dSCy Schubert    for further details.</dd>
1562b15cb3dSCy Schubert  <dt><tt>cryptostats</tt></dt>
1572b15cb3dSCy Schubert  <dd>Record significant events in the Autokey protocol. This option requires
1582b15cb3dSCy Schubert    the OpenSSL cryptographic software library. Each event appends one line to
1592b15cb3dSCy Schubert    the <tt>cryptostats</tt> file set:</dd>
1602b15cb3dSCy Schubert  <dd><tt>49213 525.624 128.4.1.1 <i>message</i></tt></dd>
1612b15cb3dSCy Schubert  <dd>
1622b15cb3dSCy Schubert    <table width="100%" border="1" cellspacing="2" cellpadding="2">
1632b15cb3dSCy Schubert      <tr>
1642b15cb3dSCy Schubert        <td>Item</td>
1652b15cb3dSCy Schubert        <td>Units</td>
1662b15cb3dSCy Schubert        <td>Description</td>
1672b15cb3dSCy Schubert      </tr>
1682b15cb3dSCy Schubert      <tr>
1692b15cb3dSCy Schubert        <td><tt>49213</tt></td>
1702b15cb3dSCy Schubert        <td>MJD</td>
1712b15cb3dSCy Schubert        <td>date</td>
1722b15cb3dSCy Schubert      </tr>
1732b15cb3dSCy Schubert      <tr>
1742b15cb3dSCy Schubert        <td><tt>525.624</tt></td>
1752b15cb3dSCy Schubert        <td>s</td>
1762b15cb3dSCy Schubert        <td>time past midnight</td>
1772b15cb3dSCy Schubert      </tr>
1782b15cb3dSCy Schubert      <tr>
1792b15cb3dSCy Schubert        <td><tt>128.4.1.1</tt></td>
1802b15cb3dSCy Schubert        <td>IP</td>
1812b15cb3dSCy Schubert        <td>source address (<tt>0.0.0.0</tt> for system)</td>
1822b15cb3dSCy Schubert      </tr>
1832b15cb3dSCy Schubert      <tr>
1842b15cb3dSCy Schubert        <td><tt><i>message</i></tt></td>
1852b15cb3dSCy Schubert        <td>text</td>
1862b15cb3dSCy Schubert        <td>log message</td>
1872b15cb3dSCy Schubert      </tr>
1882b15cb3dSCy Schubert    </table>
1892b15cb3dSCy Schubert  </dd>
1902b15cb3dSCy Schubert  <dd>The <tt><i>message</i></tt> field includes the message type and certain
1912b15cb3dSCy Schubert    ancillary information. See the <a href="authopt.html">Authentication Options</a> page
1922b15cb3dSCy Schubert    for further information.</dd>
1932b15cb3dSCy Schubert  <dt><tt>loopstats</tt></dt>
1942b15cb3dSCy Schubert  <dd>Record clock discipline loop statistics. Each system clock update appends
1952b15cb3dSCy Schubert    one line to the <tt>loopstats</tt> file set:</dd>
1962b15cb3dSCy Schubert  <dd><tt>50935 75440.031 0.000006019 13.778 0.000351733 0.013380 6</tt></dd>
1972b15cb3dSCy Schubert  <dd>
1982b15cb3dSCy Schubert    <table width="100%" border="1" cellspacing="2" cellpadding="2">
1992b15cb3dSCy Schubert      <tr>
2002b15cb3dSCy Schubert        <td>Item</td>
2012b15cb3dSCy Schubert        <td>Units</td>
2022b15cb3dSCy Schubert        <td>Description</td>
2032b15cb3dSCy Schubert      </tr>
2042b15cb3dSCy Schubert      <tr>
2052b15cb3dSCy Schubert        <td><tt>50935</tt></td>
2062b15cb3dSCy Schubert        <td>MJD</td>
2072b15cb3dSCy Schubert        <td>date</td>
2082b15cb3dSCy Schubert      </tr>
2092b15cb3dSCy Schubert      <tr>
2102b15cb3dSCy Schubert        <td><tt>75440.031</tt></td>
2112b15cb3dSCy Schubert        <td>s</td>
2122b15cb3dSCy Schubert        <td>time past midnight</td>
2132b15cb3dSCy Schubert      </tr>
2142b15cb3dSCy Schubert      <tr>
2152b15cb3dSCy Schubert        <td><tt>0.000006019</tt></td>
2162b15cb3dSCy Schubert        <td>s</td>
2172b15cb3dSCy Schubert        <td>clock offset</td>
2182b15cb3dSCy Schubert      </tr>
2192b15cb3dSCy Schubert      <tr>
2202b15cb3dSCy Schubert        <td><tt>13.778</tt></td>
2212b15cb3dSCy Schubert        <td>PPM</td>
2222b15cb3dSCy Schubert        <td>frequency offset</td>
2232b15cb3dSCy Schubert      </tr>
2242b15cb3dSCy Schubert      <tr>
2252b15cb3dSCy Schubert        <td><tt>0.000351733</tt></td>
2262b15cb3dSCy Schubert        <td>s</td>
2272b15cb3dSCy Schubert        <td>RMS jitter</td>
2282b15cb3dSCy Schubert      </tr>
2292b15cb3dSCy Schubert      <tr>
2302b15cb3dSCy Schubert        <td><tt>0.013380</tt></td>
2312b15cb3dSCy Schubert        <td>PPM</td>
2322b15cb3dSCy Schubert        <td>RMS&nbsp;frequency jitter (aka wander)</td>
2332b15cb3dSCy Schubert      </tr>
2342b15cb3dSCy Schubert      <tr>
2352b15cb3dSCy Schubert        <td><tt>6 </tt></td>
2362b15cb3dSCy Schubert        <td>log<sub>2</sub> s</td>
2372b15cb3dSCy Schubert        <td>clock discipline loop time constant</td>
2382b15cb3dSCy Schubert      </tr>
2392b15cb3dSCy Schubert    </table>
2402b15cb3dSCy Schubert  </dd>
2412b15cb3dSCy Schubert  <dt><tt>peerstats</tt></dt>
2422b15cb3dSCy Schubert  <dd>Record peer statistics. Each NTP packet or reference clock update received
2432b15cb3dSCy Schubert    appends one line to the <tt>peerstats</tt> file set:</dd>
2442b15cb3dSCy Schubert  <dd><tt>48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000 0.001424877
2452b15cb3dSCy Schubert    0.000958674</tt></dd>
2462b15cb3dSCy Schubert  <dd>
2472b15cb3dSCy Schubert    <table width="100%" border="1" cellspacing="2" cellpadding="2">
2482b15cb3dSCy Schubert      <tr>
2492b15cb3dSCy Schubert        <td>Item</td>
2502b15cb3dSCy Schubert        <td>Units</td>
2512b15cb3dSCy Schubert        <td>Description</td>
2522b15cb3dSCy Schubert      </tr>
2532b15cb3dSCy Schubert      <tr>
2542b15cb3dSCy Schubert        <td><tt>48773</tt></td>
2552b15cb3dSCy Schubert        <td>MJD</td>
2562b15cb3dSCy Schubert        <td>date</td>
2572b15cb3dSCy Schubert      </tr>
2582b15cb3dSCy Schubert      <tr>
2592b15cb3dSCy Schubert        <td><tt>10847.650</tt></td>
2602b15cb3dSCy Schubert        <td>s</td>
2612b15cb3dSCy Schubert        <td>time past midnight</td>
2622b15cb3dSCy Schubert      </tr>
2632b15cb3dSCy Schubert      <tr>
2642b15cb3dSCy Schubert        <td><tt>127.127.4.1</tt></td>
2652b15cb3dSCy Schubert        <td>IP</td>
2662b15cb3dSCy Schubert        <td>source address</td>
2672b15cb3dSCy Schubert      </tr>
2682b15cb3dSCy Schubert      <tr>
2692b15cb3dSCy Schubert        <td><tt>9714</tt></td>
2702b15cb3dSCy Schubert        <td>hex</td>
2712b15cb3dSCy Schubert        <td>status word</td>
2722b15cb3dSCy Schubert      </tr>
2732b15cb3dSCy Schubert      <tr>
2742b15cb3dSCy Schubert        <td><tt>-0.001605376</tt></td>
2752b15cb3dSCy Schubert        <td>s</td>
2762b15cb3dSCy Schubert        <td>clock offset</td>
2772b15cb3dSCy Schubert      </tr>
2782b15cb3dSCy Schubert      <tr>
2792b15cb3dSCy Schubert        <td><tt>0.000000000 </tt></td>
2802b15cb3dSCy Schubert        <td>s</td>
2812b15cb3dSCy Schubert        <td>roundtrip delay</td>
2822b15cb3dSCy Schubert      </tr>
2832b15cb3dSCy Schubert      <tr>
2842b15cb3dSCy Schubert        <td><tt>0.001424877</tt></td>
2852b15cb3dSCy Schubert        <td>s</td>
2862b15cb3dSCy Schubert        <td>dispersion</td>
2872b15cb3dSCy Schubert      </tr>
2882b15cb3dSCy Schubert      <tr>
2892b15cb3dSCy Schubert        <td><tt>0.000958674</tt></td>
2902b15cb3dSCy Schubert        <td>s</td>
2912b15cb3dSCy Schubert        <td>RMS&nbsp;jitter</td>
2922b15cb3dSCy Schubert      </tr>
2932b15cb3dSCy Schubert    </table>
2942b15cb3dSCy Schubert  </dd>
2952b15cb3dSCy Schubert  <dd>The status field is encoded in hex format as described in Appendix B of
2962b15cb3dSCy Schubert    the NTP specification RFC 1305.</dd>
2972b15cb3dSCy Schubert  <dt><tt>protostats</tt></dt>
2984990d495SXin LI  <dd>Record significant peer, system and protocol events. Each significant event
2992b15cb3dSCy Schubert    appends one line to the <tt>protostats</tt> file set:</dd>
3002b15cb3dSCy Schubert  <dd><tt>49213 525.624 128.4.1.1 963a 8a <i>message</i></tt></dd>
3012b15cb3dSCy Schubert  <dd>
3022b15cb3dSCy Schubert    <table width="100%" border="1" cellspacing="2" cellpadding="2">
3032b15cb3dSCy Schubert      <tr>
3042b15cb3dSCy Schubert        <td>Item</td>
3052b15cb3dSCy Schubert        <td>Units</td>
3062b15cb3dSCy Schubert        <td>Description</td>
3072b15cb3dSCy Schubert      </tr>
3082b15cb3dSCy Schubert      <tr>
3092b15cb3dSCy Schubert        <td><tt>49213</tt></td>
3102b15cb3dSCy Schubert        <td>MJD</td>
3112b15cb3dSCy Schubert        <td>date</td>
3122b15cb3dSCy Schubert      </tr>
3132b15cb3dSCy Schubert      <tr>
3142b15cb3dSCy Schubert        <td><tt>525.624</tt></td>
3152b15cb3dSCy Schubert        <td>s</td>
3162b15cb3dSCy Schubert        <td>time past midnight</td>
3172b15cb3dSCy Schubert      </tr>
3182b15cb3dSCy Schubert      <tr>
3192b15cb3dSCy Schubert        <td><tt>128.4.1.1</tt></td>
3202b15cb3dSCy Schubert        <td>IP</td>
3212b15cb3dSCy Schubert        <td>source address (<tt>0.0.0.0</tt> for system)</td>
3222b15cb3dSCy Schubert      </tr>
3232b15cb3dSCy Schubert      <tr>
3242b15cb3dSCy Schubert        <td><tt>963a</tt></td>
3252b15cb3dSCy Schubert        <td>code</td>
3262b15cb3dSCy Schubert        <td>status word</td>
3272b15cb3dSCy Schubert      </tr>
3282b15cb3dSCy Schubert      <tr>
3292b15cb3dSCy Schubert        <td><tt>8a</tt></td>
3302b15cb3dSCy Schubert        <td>code</td>
3312b15cb3dSCy Schubert        <td>event message code</td>
3322b15cb3dSCy Schubert      </tr>
3332b15cb3dSCy Schubert      <tr>
3342b15cb3dSCy Schubert        <td><tt><i>message</i></tt></td>
3352b15cb3dSCy Schubert        <td>text</td>
3362b15cb3dSCy Schubert        <td>event message</td>
3372b15cb3dSCy Schubert      </tr>
3382b15cb3dSCy Schubert    </table>
3392b15cb3dSCy Schubert  </dd>
3402b15cb3dSCy Schubert  <dd>The event message code and <tt><i>message</i></tt> field are described on
3412b15cb3dSCy Schubert    the <a href="decode.html">Event Messages and Status Words</a> page.</dd>
3422b15cb3dSCy Schubert  <dt><tt>rawstats</tt></dt>
3432b15cb3dSCy Schubert  <dd>Record timestamp statistics. Each NTP packet received appends one line to
344*09100258SXin LIthe <tt>rawstats</tt> file set.  As of ntp-4.2.8p11, each NTP packet written appends one line to the <tt>rawstats</tt> file set, as well.  The format of this line is:</dd>
3452b15cb3dSCy Schubert  <dd><tt>56285 54575.160 128.4.1.1 192.168.1.5 3565350574.400229473 3565350574.442385200 3565350574.442436000 3565350575.154505763 0 4 4 1 8 -21 0.000000 0.000320 .PPS.</tt></dd>
346*09100258SXin LI  <dd><tt>56285 54575.160 128.4.1.1 192.168.1.5 3565350574.400229473 3565350574.442385200 3565350574.442436000 3565350575.154505763 0 4 4 1 8 -21 0.000000 0.000320 .PPS. 4: 0000</tt></dd>
347*09100258SXin LI  </tt></dd>
3482b15cb3dSCy Schubert  <dd>
3492b15cb3dSCy Schubert    <table width="100%" border="1" cellspacing="2" cellpadding="2">
3502b15cb3dSCy Schubert      <tr>
3512b15cb3dSCy Schubert        <td>Item</td>
3522b15cb3dSCy Schubert        <td>Units</td>
3532b15cb3dSCy Schubert        <td>Description</td>
3542b15cb3dSCy Schubert      </tr>
3552b15cb3dSCy Schubert      <tr>
3562b15cb3dSCy Schubert        <td><tt>56285</tt></td>
3572b15cb3dSCy Schubert        <td>MJD</td>
3582b15cb3dSCy Schubert        <td>date</td>
3592b15cb3dSCy Schubert      </tr>
3602b15cb3dSCy Schubert      <tr>
3612b15cb3dSCy Schubert        <td><tt>54575.160</tt></td>
3622b15cb3dSCy Schubert        <td>s</td>
3632b15cb3dSCy Schubert        <td>time past midnight</td>
3642b15cb3dSCy Schubert      </tr>
3652b15cb3dSCy Schubert      <tr>
3662b15cb3dSCy Schubert        <td><tt>128.4.1.1</tt></td>
3672b15cb3dSCy Schubert        <td>IP</td>
3682b15cb3dSCy Schubert        <td>source address</td>
3692b15cb3dSCy Schubert      </tr>
3702b15cb3dSCy Schubert      <tr>
3712b15cb3dSCy Schubert        <td><tt>192.168.1.5</tt></td>
3722b15cb3dSCy Schubert        <td>IP</td>
3732b15cb3dSCy Schubert        <td>destination address</td>
3742b15cb3dSCy Schubert      </tr>
3752b15cb3dSCy Schubert      <tr>
3762b15cb3dSCy Schubert        <td><tt>3565350574.400229473</tt></td>
3772b15cb3dSCy Schubert        <td>NTP&nbsp;s</td>
3782b15cb3dSCy Schubert        <td>origin timestamp</td>
3792b15cb3dSCy Schubert      </tr>
3802b15cb3dSCy Schubert      <tr>
3812b15cb3dSCy Schubert        <td><tt>3565350574.442385200</tt></td>
3822b15cb3dSCy Schubert        <td>NTP s</td>
3832b15cb3dSCy Schubert        <td>receive timestamp</td>
3842b15cb3dSCy Schubert      </tr>
3852b15cb3dSCy Schubert      <tr>
3862b15cb3dSCy Schubert        <td><tt>3565350574.442436000</tt></td>
3872b15cb3dSCy Schubert        <td>NTP s</td>
3882b15cb3dSCy Schubert        <td>transmit timestamp</td>
3892b15cb3dSCy Schubert      </tr>
3902b15cb3dSCy Schubert      <tr>
3912b15cb3dSCy Schubert        <td><tt>3565350575.154505763</tt></td>
3922b15cb3dSCy Schubert        <td>NTP&nbsp;s</td>
3932b15cb3dSCy Schubert        <td>destination timestamp</td>
3942b15cb3dSCy Schubert      </tr>
3952b15cb3dSCy Schubert      <tr>
3962b15cb3dSCy Schubert        <td><tt>0</tt></td>
3972b15cb3dSCy Schubert        <td>0: OK, 1: insert pending,<br>2: delete pending, 3: not synced</td>
3982b15cb3dSCy Schubert        <td>leap warning indicator</td>
3992b15cb3dSCy Schubert      </tr>
4002b15cb3dSCy Schubert      <tr>
4012b15cb3dSCy Schubert        <td><tt>4</tt></td>
4022b15cb3dSCy Schubert        <td>4 was current in 2012</td>
4032b15cb3dSCy Schubert        <td>NTP version</td>
4042b15cb3dSCy Schubert      </tr>
4052b15cb3dSCy Schubert      <tr>
4062b15cb3dSCy Schubert        <td><tt>4</tt></td>
4072b15cb3dSCy Schubert        <td>3: client, 4: server, 5: broadcast</td>
4082b15cb3dSCy Schubert        <td>mode</td>
4092b15cb3dSCy Schubert      </tr>
4102b15cb3dSCy Schubert      <tr>
4112b15cb3dSCy Schubert        <td><tt>1</tt></td>
4122b15cb3dSCy Schubert        <td>1-15, 16: not synced</td>
4132b15cb3dSCy Schubert        <td>stratum</td>
4142b15cb3dSCy Schubert      </tr>
4152b15cb3dSCy Schubert      <tr>
4162b15cb3dSCy Schubert        <td><tt>8</tt></td>
4172b15cb3dSCy Schubert        <td>log<sub>2</sub> seconds</td>
4182b15cb3dSCy Schubert        <td>poll</td>
4192b15cb3dSCy Schubert      </tr>
4202b15cb3dSCy Schubert      <tr>
4212b15cb3dSCy Schubert        <td><tt>-21</tt></td>
4222b15cb3dSCy Schubert        <td>log<sub>2</sub> seconds</td>
4232b15cb3dSCy Schubert        <td>precision</td>
4242b15cb3dSCy Schubert      </tr>
4252b15cb3dSCy Schubert      <tr>
4262b15cb3dSCy Schubert        <td><tt>0.000000</tt></td>
4272b15cb3dSCy Schubert        <td>seconds</td>
4282b15cb3dSCy Schubert        <td>total roundtrip delay to the primary reference clock</td>
4292b15cb3dSCy Schubert      </tr>
4302b15cb3dSCy Schubert      <tr>
4312b15cb3dSCy Schubert        <td><tt>0.000320</tt></td>
4322b15cb3dSCy Schubert        <td>seconds</td>
4332b15cb3dSCy Schubert        <td>total dispersion to the primary reference clock</td>
4342b15cb3dSCy Schubert      </tr>
4352b15cb3dSCy Schubert      <tr>
436*09100258SXin LI        <td><tt>.PPS.</tt></td>
437*09100258SXin LI        <td>REFID</td>
438*09100258SXin LI        <td>system peer, association ID</td>
439*09100258SXin LI      </tr>
440*09100258SXin LI      <tr>
441*09100258SXin LI	<td></td>
442*09100258SXin LI	<td></td>
443*09100258SXin LI        <td>If there is data beyond the base packet:</td>
444*09100258SXin LI      </tr>
445*09100258SXin LI      <tr>
446*09100258SXin LI        <td><tt>4:</tt></td>
447*09100258SXin LI        <td>Integer</td>
448*09100258SXin LI        <td>Length, in bytes</td>
449*09100258SXin LI      </tr>
450*09100258SXin LI      <tr>
451*09100258SXin LI        <td><tt>0000</tt></td>
452*09100258SXin LI        <td>Hex data</td>
4532b15cb3dSCy Schubert      </tr>
4542b15cb3dSCy Schubert    </table>
4552b15cb3dSCy Schubert  </dd>
4562b15cb3dSCy Schubert  <dt><tt>sysstats</tt></dt>
4572b15cb3dSCy Schubert  <dd>Record system statistics. Each hour one line is appended to the <tt>sysstats</tt> file
4582b15cb3dSCy Schubert    set in the following format:</dd>
4592b15cb3dSCy Schubert  <dd><tt>50928 2132.543 3600 81965 0 9546 56 512 540 10 4 147 1</tt></dd>
4602b15cb3dSCy Schubert  <dd>
4612b15cb3dSCy Schubert    <table width="100%" border="1" cellspacing="2" cellpadding="2">
4622b15cb3dSCy Schubert      <tr>
4632b15cb3dSCy Schubert        <td>Item</td>
4642b15cb3dSCy Schubert        <td>Units</td>
4652b15cb3dSCy Schubert        <td>Description</td>
4662b15cb3dSCy Schubert      </tr>
4672b15cb3dSCy Schubert      <tr>
4682b15cb3dSCy Schubert        <td><tt>50928</tt></td>
4692b15cb3dSCy Schubert        <td>MJD</td>
4702b15cb3dSCy Schubert        <td>date</td>
4712b15cb3dSCy Schubert      </tr>
4722b15cb3dSCy Schubert      <tr>
4732b15cb3dSCy Schubert        <td><tt>2132.543</tt></td>
4742b15cb3dSCy Schubert        <td>s</td>
4752b15cb3dSCy Schubert        <td>time past midnight</td>
4762b15cb3dSCy Schubert      </tr>
4772b15cb3dSCy Schubert      <tr>
4782b15cb3dSCy Schubert        <td><tt>3600</tt></td>
4792b15cb3dSCy Schubert        <td>s</td>
4802b15cb3dSCy Schubert        <td>time since reset</td>
4812b15cb3dSCy Schubert      </tr>
4822b15cb3dSCy Schubert      <tr>
4832b15cb3dSCy Schubert        <td><tt>81965</tt></td>
4842b15cb3dSCy Schubert        <td>#</td>
4852b15cb3dSCy Schubert        <td>packets received</td>
4862b15cb3dSCy Schubert      </tr>
4872b15cb3dSCy Schubert      <tr>
4882b15cb3dSCy Schubert        <td><tt>0</tt></td>
4892b15cb3dSCy Schubert        <td>#</td>
4902b15cb3dSCy Schubert        <td>packets for this host</td>
4912b15cb3dSCy Schubert      </tr>
4922b15cb3dSCy Schubert      <tr>
4932b15cb3dSCy Schubert        <td><tt>9546</tt></td>
4942b15cb3dSCy Schubert        <td>#</td>
4952b15cb3dSCy Schubert        <td>current versions</td>
4962b15cb3dSCy Schubert      </tr>
4972b15cb3dSCy Schubert      <tr>
4982b15cb3dSCy Schubert        <td><tt>56</tt></td>
4992b15cb3dSCy Schubert        <td>#</td>
5002b15cb3dSCy Schubert        <td>old version</td>
5012b15cb3dSCy Schubert      </tr>
5022b15cb3dSCy Schubert      <tr>
5032b15cb3dSCy Schubert        <td><tt>512</tt></td>
5042b15cb3dSCy Schubert        <td>#</td>
5052b15cb3dSCy Schubert        <td>access denied</td>
5062b15cb3dSCy Schubert      </tr>
5072b15cb3dSCy Schubert      <tr>
5082b15cb3dSCy Schubert        <td><tt>540</tt></td>
5092b15cb3dSCy Schubert        <td>#</td>
5102b15cb3dSCy Schubert        <td>bad length or format</td>
5112b15cb3dSCy Schubert      </tr>
5122b15cb3dSCy Schubert      <tr>
5132b15cb3dSCy Schubert        <td><tt>10</tt></td>
5142b15cb3dSCy Schubert        <td>#</td>
5152b15cb3dSCy Schubert        <td>bad authentication</td>
5162b15cb3dSCy Schubert      </tr>
5172b15cb3dSCy Schubert      <tr>
5182b15cb3dSCy Schubert        <td><tt>4</tt></td>
5192b15cb3dSCy Schubert        <td>#</td>
5202b15cb3dSCy Schubert        <td>declined</td>
5212b15cb3dSCy Schubert      </tr>
5222b15cb3dSCy Schubert      <tr>
5232b15cb3dSCy Schubert        <td><tt>147</tt></td>
5242b15cb3dSCy Schubert        <td>#</td>
5252b15cb3dSCy Schubert        <td>rate exceeded</td>
5262b15cb3dSCy Schubert      </tr>
5272b15cb3dSCy Schubert      <tr>
5282b15cb3dSCy Schubert        <td><tt>1</tt></td>
5292b15cb3dSCy Schubert        <td>#</td>
5302b15cb3dSCy Schubert        <td>kiss-o'-death packets sent</td>
5312b15cb3dSCy Schubert      </tr>
5322b15cb3dSCy Schubert    </table>
5332b15cb3dSCy Schubert  </dd>
5342b15cb3dSCy Schubert  <dt><tt>timingstats</tt></dt>
535*09100258SXin LI  <dd>(Only available when the daemon is compiled with process time debugging
5362b15cb3dSCy Schubert    support (--enable-debug-timing - costs performance). Record processing time
5372b15cb3dSCy Schubert    statistics for various selected code paths.</dd>
5382b15cb3dSCy Schubert  <dd><tt>53876 36.920 10.0.3.5 1 0.000014592 input processing delay</tt></dd>
5392b15cb3dSCy Schubert  <dd>
5402b15cb3dSCy Schubert    <table width="100%" border="1" cellspacing="2" cellpadding="2">
5412b15cb3dSCy Schubert      <tr>
5422b15cb3dSCy Schubert        <td>Item</td>
5432b15cb3dSCy Schubert        <td>Units</td>
5442b15cb3dSCy Schubert        <td>Description</td>
5452b15cb3dSCy Schubert      </tr>
5462b15cb3dSCy Schubert      <tr>
5472b15cb3dSCy Schubert        <td><tt>53876</tt></td>
5482b15cb3dSCy Schubert        <td>MJD</td>
5492b15cb3dSCy Schubert        <td>date</td>
5502b15cb3dSCy Schubert      </tr>
5512b15cb3dSCy Schubert      <tr>
5522b15cb3dSCy Schubert        <td><tt>36.920</tt></td>
5532b15cb3dSCy Schubert        <td>s</td>
5542b15cb3dSCy Schubert        <td>time past midnight</td>
5552b15cb3dSCy Schubert      </tr>
5562b15cb3dSCy Schubert      <tr>
5572b15cb3dSCy Schubert        <td><tt>10.0.3.5</tt></td>
5582b15cb3dSCy Schubert        <td>IP</td>
5592b15cb3dSCy Schubert        <td>server address</td>
5602b15cb3dSCy Schubert      </tr>
5612b15cb3dSCy Schubert      <tr>
5622b15cb3dSCy Schubert        <td><tt>1</tt></td>
5632b15cb3dSCy Schubert        <td>#</td>
5642b15cb3dSCy Schubert        <td>event count</td>
5652b15cb3dSCy Schubert      </tr>
5662b15cb3dSCy Schubert      <tr>
5672b15cb3dSCy Schubert        <td><tt>0.000014592</tt></td>
5682b15cb3dSCy Schubert        <td>s</td>
5692b15cb3dSCy Schubert        <td>total time</td>
5702b15cb3dSCy Schubert      </tr>
5712b15cb3dSCy Schubert      <tr>
5722b15cb3dSCy Schubert        <td><tt><i>message</i></tt></td>
5732b15cb3dSCy Schubert        <td>text</td>
5742b15cb3dSCy Schubert        <td>code path description (see source)</td>
5752b15cb3dSCy Schubert      </tr>
5762b15cb3dSCy Schubert    </table>
5772b15cb3dSCy Schubert  </dd>
5789c2daa00SOllivier Robert</dl>
5799c2daa00SOllivier Robert<hr>
5809c2daa00SOllivier Robert<script type="text/javascript" language="javascript" src="scripts/footer.txt"></script>
5819c2daa00SOllivier Robert</body>
5829c2daa00SOllivier Robert</html>
583