Browse Source

[master] document other b10-stats statistics

Jeremy C. Reed 13 years ago
parent
commit
98e74ad62b
1 changed files with 38 additions and 17 deletions
  1. 38 17
      src/bin/stats/b10-stats.xml

+ 38 - 17
src/bin/stats/b10-stats.xml

@@ -143,8 +143,7 @@
     <title>STATISTICS DATA</title>
 
     <para>
-      The <command>b10-stats</command> daemon contains
-      built-in statistics:
+      The <command>b10-stats</command> daemon contains these statistics:
     </para>
 
     <variablelist>
@@ -157,6 +156,38 @@
       </varlistentry>
 
       <varlistentry>
+        <term>stats.boot_time</term>
+        <listitem><simpara>The date and time when this daemon was
+          started in ISO 8601 format.
+          This is a constant which can't be reset except by restarting
+          <command>b10-stats</command>.
+        </simpara></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>stats.last_update_time</term>
+        <listitem><simpara>The date and time (in ISO 8601 format)
+          when this daemon last received data from another component.
+        </simpara></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>stats.lname</term>
+        <listitem><simpara>This is the name used for the
+          <command>b10-msgq</command> command-control channel.
+          (This is a constant which can't be reset except by restarting
+          <command>b10-stats</command>.)
+        </simpara></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>stats.start_time</term>
+        <listitem><simpara>This is the date and time (in ISO 8601 format)
+          when this daemon started collecting data.
+        </simpara></listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term>stats.timestamp</term>
         <listitem><simpara>The current date and time represented in
           seconds since UNIX epoch (1970-01-01T0 0:00:00Z) with
@@ -164,23 +195,13 @@
           one hundred thousandth of second.</simpara></listitem>
       </varlistentry>
 
-<!-- TODO: document
-    "stats.boot_time": "2011-08-11T15:23:56Z",
-when started
-stats.boot_time is a constant which can't be reset.
-    "stats.last_update_time": "2011-08-11T15:23:56Z",
-when stats module last received data from other component
-    "stats.lname": "4e43f40c_15@t1.m.reedmedia.net",
-stats.lname is a constant which can't be reset.
-name used for msgq command-control channel
-    "stats.start_time": "2011-08-11T15:23:56Z",
-when starts collecting data
--->
-
-<!-- TODO: document auth.foo and bind10.foo in their corresponding manuals -->
-
     </variablelist>
 
+    <para>
+      See other manual pages for explanations for their statistics
+      that are kept track by <command>b10-stats</command>.
+    </para>
+
   </refsect1>
 
   <refsect1>