BIND 10 jreed-docs-2, updated. f14bc0502c3c4d2ffd609b110771ca1fa752b68e [jreed-docs-2] document the statistics data for the auth server
BIND 10 source code commits
bind10-changes at lists.isc.org
Thu Aug 11 16:04:29 UTC 2011
The branch, jreed-docs-2 has been updated
via f14bc0502c3c4d2ffd609b110771ca1fa752b68e (commit)
via f75d5bd488669426794d086b80568ef0a7a4afe6 (commit)
via c7db1351d3b1c25bfc31ed9e7b6b491e6bcb1555 (commit)
from 525d9602da83a5d8ddbfc9ebda282209aa743a70 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit f14bc0502c3c4d2ffd609b110771ca1fa752b68e
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Thu Aug 11 11:04:17 2011 -0500
[jreed-docs-2] document the statistics data for the auth server
commit f75d5bd488669426794d086b80568ef0a7a4afe6
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Thu Aug 11 11:03:44 2011 -0500
[jreed-docs-2] document the statistics data for bind10 parent
commit c7db1351d3b1c25bfc31ed9e7b6b491e6bcb1555
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Thu Aug 11 11:02:54 2011 -0500
[jreed-docs-2] begin documenting stats commands and builtin in stats items
-----------------------------------------------------------------------
Summary of changes:
src/bin/auth/b10-auth.xml | 30 +++++++++++++-
src/bin/bind10/bind10.xml | 28 ++++++++++++-
src/bin/stats/b10-stats.xml | 93 ++++++++++++++++++++++++++++++++++++++++++-
3 files changed, 146 insertions(+), 5 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/bin/auth/b10-auth.xml b/src/bin/auth/b10-auth.xml
index 2b53394..a05be58 100644
--- a/src/bin/auth/b10-auth.xml
+++ b/src/bin/auth/b10-auth.xml
@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
- <date>March 8, 2011</date>
+ <date>August 11, 2011</date>
</refentryinfo>
<refmeta>
@@ -209,6 +209,34 @@
</refsect1>
<refsect1>
+ <title>STATISTICS DATA</title>
+
+ <para>
+ The statistics data collected by the <command>b10-stats</command>
+ daemon include:
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term>auth.queries.tcp</term>
+ <listitem><simpara>Total count of queries received by the
+ <command>b10-auth</command> server over TCP since startup.
+ </simpara></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>auth.queries.udp</term>
+ <listitem><simpara>Total count of queries received by the
+ <command>b10-auth</command> server over UDP since startup.
+ </simpara></listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1>
<title>FILES</title>
<para>
<filename>/usr/local/var/bind10-devel/zone.sqlite3</filename>
diff --git a/src/bin/bind10/bind10.xml b/src/bin/bind10/bind10.xml
index 1128264..b101ba8 100644
--- a/src/bin/bind10/bind10.xml
+++ b/src/bin/bind10/bind10.xml
@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "—">]>
<!--
- - Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+ - Copyright (C) 2010-2011 Internet Systems Consortium, Inc. ("ISC")
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
- <date>March 31, 2011</date>
+ <date>August 11, 2011</date>
</refentryinfo>
<refmeta>
@@ -217,6 +217,30 @@ The default is the basename of ARG 0.
<!--
TODO: configuration section
-->
+
+ <refsect1>
+ <title>STATISTICS DATA</title>
+
+ <para>
+ The statistics data collected by the <command>b10-stats</command>
+ daemon include:
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term>bind10.boot_time</term>
+ <listitem><para>
+ The date and time that the <command>bind10</command>
+ process started.
+ This is represented in ISO 8601 format.
+ </para></listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
<!--
<refsect1>
<title>FILES</title>
diff --git a/src/bin/stats/b10-stats.xml b/src/bin/stats/b10-stats.xml
index f0c472d..13e568d 100644
--- a/src/bin/stats/b10-stats.xml
+++ b/src/bin/stats/b10-stats.xml
@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
- <date>Oct 15, 2010</date>
+ <date>August 11, 2011</date>
</refentryinfo>
<refmeta>
@@ -67,6 +67,7 @@
it. <command>b10-stats</command> invokes "sendstats" command
for <command>bind10</command> after its initial starting because it's
sure to collect statistics data from <command>bind10</command>.
+<!-- TODO: reword that last sentence? -->
</para>
</refsect1>
@@ -87,6 +88,94 @@
</refsect1>
<refsect1>
+ <title>DEFAULT STATISTICS</title>
+
+ <para>
+ The <command>b10-stats</command> daemon contains
+ built-in statistics:
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term>report_time</term>
+<!-- TODO: why not named stats.report_time? -->
+ <listitem><simpara>The latest report date and time in
+ ISO 8601 format.</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
+ precision (delimited with a period) up to
+ one hundred thousandth of second.</simpara></listitem>
+ </varlistentry>
+
+<!-- TODO: document
+ "stats.boot_time": "2011-08-11T15:23:56Z",
+when started
+ "stats.last_update_time": "2011-08-11T15:23:56Z",
+when stats module last received data from other component
+ "stats.lname": "4e43f40c_15 at t1.m.reedmedia.net",
+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>
+
+ </refsect1>
+
+ <refsect1>
+ <title>CONFIGURATION AND COMMANDS</title>
+
+ <para>
+ The <command>b10-stats</command> command does not have any
+ configurable settings.
+ </para>
+
+<!-- TODO: formating -->
+ <para>
+ The configuration commands are:
+ </para>
+
+ <para>
+ <command>remove</command> removes the named statistics data.
+ </para>
+
+ <para>
+ <command>reset</command>
+ </para>
+
+ <para>
+ <command>set</command>
+ </para>
+
+ <para>
+ <command>show</command> will send the statistics data
+ in JSON format.
+ By default, it outputs all the statistics data it has collected.
+ An optional item name may be specified to receive individual output.
+ </para>
+
+ <para>
+ <command>shutdown</command> will shutdown the
+ <command>b10-stats</command> process.
+ (Note that the <command>bind10</command> parent may restart it.)
+ </para>
+
+ <para>
+ <command>status</command> simply indicates that the daemon is
+ running.
+ </para>
+
+ </refsect1>
+
+
+ <refsect1>
<title>FILES</title>
<para><filename>/usr/local/share/bind10-devel/stats.spec</filename>
<!--TODO: The filename should be computed from prefix-->
@@ -126,7 +215,7 @@
<title>HISTORY</title>
<para>
The <command>b10-stats</command> daemon was initially designed
- and implemented by Naoki Kambe of JPRS in Oct 2010.
+ and implemented by Naoki Kambe of JPRS in October 2010.
</para>
</refsect1>
</refentry><!--
More information about the bind10-changes
mailing list