Browse Source

[master] clarify reset and remove

even those these may be removed from stats soon.

Also add some TODO comments
Jeremy C. Reed 13 years ago
parent
commit
691c232b26
1 changed files with 11 additions and 2 deletions
  1. 11 2
      src/bin/stats/b10-stats.xml

+ 11 - 2
src/bin/stats/b10-stats.xml

@@ -115,9 +115,11 @@
 <!-- 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
@@ -143,15 +145,20 @@ when starts collecting data
     </para>
 
     <para>
-      <command>remove</command> removes the named statistics data.
+<!-- TODO: remove is removed in trac930 -->
+      <command>remove</command> removes the named statistics name and data.
     </para>
 
     <para>
-      <command>reset</command>
+<!-- TODO: reset is removed in trac930 -->
+      <command>reset</command> will reset all statistics data to
+      default values except for constant names.
+      This may re-add previously removed statistics names.
     </para>
 
     <para>
       <command>set</command>
+<!-- TODO: document this -->
     </para>
 
     <para>
@@ -161,6 +168,8 @@ when starts collecting data
       An optional item name may be specified to receive individual output.
     </para>
 
+<!-- TODO: document showschema -->
+
     <para>
       <command>shutdown</command> will shutdown the
       <command>b10-stats</command> process.