diff options
author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-02-05 14:04:09 -0500 |
---|---|---|
committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-02-05 14:04:09 -0500 |
commit | 25cb6db5ccb0c8e8302c220a90344a95baf3909b (patch) | |
tree | 80d6a81f2dcd164f0b127bdfe75a4b2d833c6be6 /doc/development/plugins.txt | |
parent | 5d237f71575a109c10d5aad8d70dc5dda00a2d96 (diff) | |
download | bcfg2-25cb6db5ccb0c8e8302c220a90344a95baf3909b.tar.gz bcfg2-25cb6db5ccb0c8e8302c220a90344a95baf3909b.tar.bz2 bcfg2-25cb6db5ccb0c8e8302c220a90344a95baf3909b.zip |
moved some libraries in Bcfg2/ into more specific (Server/ or Client/) places
Diffstat (limited to 'doc/development/plugins.txt')
-rw-r--r-- | doc/development/plugins.txt | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/development/plugins.txt b/doc/development/plugins.txt index 91a4e6868..04b9ff7b1 100644 --- a/doc/development/plugins.txt +++ b/doc/development/plugins.txt @@ -128,13 +128,15 @@ The two attributes you need to know about are: of the caching mode. See :ref:`server-caching` for a description of each mode. * :attr:`Bcfg2.Server.Core.metadata_cache`: A dict-like - :class:`Bcfg2.Cache.Cache` object that stores the cached data. + :class:`Bcfg2.Server.Cache.Cache` object that stores the cached + data. :class:`Bcfg2.Server.Plugin.base.Plugin` objects have access to the :class:`Bcfg2.Server.Core` object as ``self.core``. In general, -you'll be interested in the :func:`Bcfg2.Cache.Cache.expire` method; -if called with no arguments, it expires all cached data; if called -with one string argument, it expires cached data for the named client. +you'll be interested in the :func:`Bcfg2.Server.Cache.Cache.expire` +method; if called with no arguments, it expires all cached data; if +called with one string argument, it expires cached data for the named +client. It's important, therefore, that your Connector plugin can either track when changes are made to the group membership it reports, and expire @@ -163,7 +165,7 @@ Tracking Execution Time .. versionadded:: 1.3.0 Statistics can and should track execution time statistics using -:mod:`Bcfg2.Statistics`. This module tracks execution time for the +:mod:`Bcfg2.Server.Statistics`. This module tracks execution time for the server core and for plugins, and exposes that data via ``bcfg2-admin perf``. This data can be invaluable for locating bottlenecks or other performance issues. @@ -175,7 +177,7 @@ decorate functions that you would like to track execution times for: .. code-block:: python from Bcfg2.Server.Plugin import track_statistics - + @track_statistics() def do_something(self, ...): ... @@ -184,13 +186,13 @@ This will track the execution time of ``do_something``. More granular usage is possible by using :func:`time.time` to manually determine the execution time of a given event and calling -:func:`Bcfg2.Statistics.Statistics.add_value` with an appropriate +:func:`Bcfg2.Server.Statistics.Statistics.add_value` with an appropriate statistic name. -Bcfg2.Statistics -^^^^^^^^^^^^^^^^ +Bcfg2.Server.Statistics +^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: Bcfg2.Statistics +.. automodule:: Bcfg2.Server.Statistics Plugin Helper Classes --------------------- |