BIND 10 trac2843, updated. 42407bf17bcaad492cfb9264dd713ad0e0c4f84c [2843] revise docstring of dns.Counters()
BIND 10 source code commits
bind10-changes at lists.isc.org
Thu Jul 11 11:00:00 UTC 2013
The branch, trac2843 has been updated
via 42407bf17bcaad492cfb9264dd713ad0e0c4f84c (commit)
via 2ca4520e166d0d07232d0fb9cc31587f77176960 (commit)
from 6f1a5fd22d80b90a5854d4e9c03f1aed13f32bac (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 42407bf17bcaad492cfb9264dd713ad0e0c4f84c
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Jul 11 17:37:09 2013 +0900
[2843] revise docstring of dns.Counters()
commit 2ca4520e166d0d07232d0fb9cc31587f77176960
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Jul 11 17:36:22 2013 +0900
[2843] revise docstrings of counters.py and dns.py
counters.py's documentation becomes more generic. DNS-specific documentation
which was in counters.py, is added into dns.py.
-----------------------------------------------------------------------
Summary of changes:
src/lib/python/isc/statistics/counters.py | 54 +++++++++----------------
src/lib/python/isc/statistics/dns.py | 62 +++++++++++++++++++++++++----
2 files changed, 72 insertions(+), 44 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/lib/python/isc/statistics/counters.py b/src/lib/python/isc/statistics/counters.py
index ae2db94..fc5d763 100644
--- a/src/lib/python/isc/statistics/counters.py
+++ b/src/lib/python/isc/statistics/counters.py
@@ -17,52 +17,34 @@
This module handles the statistics counters for BIND 10 modules. For
using the module `counter.py`, first a counters object should be created
-in each module (like b10-xfrin or b10-xfrout) after importing this
-module. A spec file can be specified as an argument when creating the
-counters object:
+in each module like b10-foo after importing this module. A spec file can
+be specified as an argument when creating the counters object:
from isc.statistics import Counters
self.counters = Counters("/path/to/foo.spec")
The first argument of Counters() can be specified, which is the location
-of the specification file (like src/bin/xfrout/xfrout.spec). If Counters
-is constructed this way, statistics counters can be accessed from each
-module. For example, in case that the item `xfrreqdone` is defined in
-statistics_spec in xfrout.spec, the following methods are
-callable. Since these methods require the string of the zone name in the
-first argument, if we have the following code in b10-xfrout:
+of the specification file. If Counters is constructed this way,
+statistics counters can be accessed from each module. For example, in
+case that the item `counter1` is defined in statistics_spec in foo.spec,
+the following methods are callable.
- self.counters.inc('zones', zone_name, 'xfrreqdone')
+ self.counters.inc('counter1')
-then the counter for xfrreqdone corresponding to zone_name is
-incremented. For getting the current number of this counter, we can use
-the following code:
+Then the counter for `counter1` is incremented. For getting the current
+number of this counter, we can use the following code:
- number = self.counters.get('zones', zone_name, 'xfrreqdone')
+ number = self.counters.get('counter1')
-then the current count is obtained and set in the variable
+Then the current count is obtained and set in the variable
`number`. Such a getter method would be mainly used for unit-testing.
-As other example, for the item `axfr_running`, the decrementer method is
-also callable. This method is used for decrementing a counter. For the
-item `axfr_running`, an argument like zone name is not required:
-
- self.counters.dec('axfr_running')
-
-These methods are effective in other modules. For example, in case that
-this module `counter.py` is once imported in a main module such as
-b10-xfrout, then for the item `notifyoutv4`, the `inc()` method can be
-invoked in another module such as notify_out.py, which is firstly
-imported in the main module.
-
- self.counters.inc('zones', zone_name, 'notifyoutv4')
-
-In this example this is for incrementing the counter of the item
-`notifyoutv4`. Thus, such statement can be also written in another
-library like isc.notify.notify_out. If this module `counter.py` isn't
-imported in the main module but imported in such a library module as
-isc.notify.notify_out, in this example, empty methods would be invoked,
-which is directly defined in `counter.py`.
-"""
+The decrementer method is also callable. This method is used for
+decrementing a counter as well as inc().
+
+ self.counters.dec('counter2')
+
+Some other methods accessible to a counter are provided by this
+module."""
import threading
import isc.config
diff --git a/src/lib/python/isc/statistics/dns.py b/src/lib/python/isc/statistics/dns.py
index 37e4968..b5cdcf0 100644
--- a/src/lib/python/isc/statistics/dns.py
+++ b/src/lib/python/isc/statistics/dns.py
@@ -15,11 +15,56 @@
"""BIND 10 statistics counters module for DNS
-This module basically inherits the class in isc.statistics.counters.
-It handles DNS-specific information. For a DNS purpose, each BIND 10
-module uses this module instead of the parent module
-(isc.statistics.counters). Also see isc.statistics.counters.__doc__
-for details."""
+This module handles the statistics counters for BIND 10 modules for a
+DNS-specific purpose. For using the module `counter.py`, first a
+counters object should be created in each module (like b10-xfrin or
+b10-xfrout) after importing this module. A spec file can be specified as
+an argument when creating the counters object:
+
+ from isc.statistics.dns import Counters
+ self.counters = Counters("/path/to/xfrout/xfrout.spec")
+
+The first argument of Counters() can be specified, which is the location
+of the specification file. If Counters is constructed this way,
+statistics counters can be accessed from each module. For example, in
+case that the item `xfrreqdone` is defined in statistics_spec in
+xfrout.spec, the following methods are callable. Since these methods
+require the string of the zone name in the first argument, if we have
+the following code in b10-xfrout:
+
+ self.counters.inc('zones', zone_name, 'xfrreqdone')
+
+then the counter for xfrreqdone corresponding to zone_name is
+incremented. For getting the current number of this counter, we can use
+the following code:
+
+ number = self.counters.get('zones', zone_name, 'xfrreqdone')
+
+then the current count is obtained and set in the variable
+`number`. Such a getter method would be mainly used for unit-testing.
+As other example, for the item `axfr_running`, the decrementer method is
+also callable. This method is used for decrementing a counter. For the
+item `axfr_running`, an argument like zone name is not required:
+
+ self.counters.dec('axfr_running')
+
+These methods are effective in other modules. For example, in case that
+this module `counters.py` is once imported in a main module such as
+b10-xfrout, then for the item `notifyoutv4`, the `inc()` method can be
+invoked in another module such as notify_out.py, which is firstly
+imported in the main module.
+
+ self.counters.inc('zones', zone_name, 'notifyoutv4')
+
+In this example this is for incrementing the counter of the item
+`notifyoutv4`. Thus, such statement can be also written in another
+library like isc.notify.notify_out. If this module `counter.py` isn't
+imported in the main module but imported in such a library module as
+isc.notify.notify_out, in this example, empty methods would be invoked,
+which is directly defined in `counter.py`.
+
+This module basically inherits isc.statistics.counters. Also see
+isc.statistics.counters.__doc__ for details."""
import isc.config
from isc.statistics import counters
@@ -133,9 +178,10 @@ class Counters(counters.Counters):
_statistics = _Statistics()
def __init__(self, spec_file_name=None):
- """If the spec file has 'zones', it obtains a list of counter
- names under it when initiating. For behaviors other than
- this, see isc.statistics.counters.Counters.__init__.__doc__."""
+ """If the item `zones` is defined in the spec file, it obtains a
+ list of counter names under it when initiating. For behaviors
+ other than this, see
+ isc.statistics.counters.Counters.__init__.__doc__."""
counters.Counters.__init__(self, spec_file_name)
if self._perzone_prefix in \
isc.config.spec_name_list(self._statistics._spec):
More information about the bind10-changes
mailing list