<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Bcfg2.Statistics — Bcfg2 1.3.0 documentation</title> <link rel="stylesheet" href="../../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '1.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <script type="text/javascript" src="../../_static/sidebar.js"></script> <link rel="shortcut icon" href="../../_static/favicon.ico"/> <link rel="top" title="Bcfg2 1.3.0 documentation" href="../../index.html" /> <link rel="up" title="Module code" href="../index.html" /> <link rel="stylesheet" href="../../_static/bcfg2.css" type=""/> </head> <body> <div style="text-align: left; padding: 10px 10px 15px 15px"> <a href="../../index.html"><img src="../../_static/bcfg2_logo.png" border="0" alt="sampledoc"/></a> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li><a href="../../index.html">home</a> | </li> <!--<li><a href="../../search.html">search</a> | </li>--> <li><a href="../../help/index.html">help</a> | </li> <li><a href="../../contents.html">documentation </a> »</li> <li><a href="../index.html" accesskey="U">Module code</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <h1>Source code for Bcfg2.Statistics</h1><div class="highlight"><pre> <span class="sd">""" Module for tracking execution time statistics from the Bcfg2</span> <span class="sd">server core. This data is exposed by</span> <span class="sd">:func:`Bcfg2.Server.Core.BaseCore.get_statistics`."""</span> <div class="viewcode-block" id="Statistic"><a class="viewcode-back" href="../../development/plugins.html#Bcfg2.Statistics.Statistic">[docs]</a><span class="k">class</span> <span class="nc">Statistic</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> <span class="sd">""" A single named statistic, tracking minimum, maximum, and</span> <span class="sd"> average execution time, and number of invocations. """</span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">initial_value</span><span class="p">):</span> <span class="sd">"""</span> <span class="sd"> :param name: The name of this statistic</span> <span class="sd"> :type name: string</span> <span class="sd"> :param initial_value: The initial value to be added to this</span> <span class="sd"> statistic</span> <span class="sd"> :type initial_value: int or float</span> <span class="sd"> """</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> <span class="bp">self</span><span class="o">.</span><span class="n">min</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">initial_value</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">max</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">initial_value</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">ave</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">initial_value</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">=</span> <span class="mi">1</span> <div class="viewcode-block" id="Statistic.add_value"><a class="viewcode-back" href="../../development/plugins.html#Bcfg2.Statistics.Statistic.add_value">[docs]</a> <span class="k">def</span> <span class="nf">add_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="sd">""" Add a value to the statistic, recalculating the various</span> <span class="sd"> metrics.</span> <span class="sd"> :param value: The value to add to this statistic</span> <span class="sd"> :type value: int or float</span> <span class="sd"> """</span> <span class="bp">self</span><span class="o">.</span><span class="n">min</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">min</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">max</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">ave</span> <span class="o">=</span> <span class="p">(((</span><span class="bp">self</span><span class="o">.</span><span class="n">ave</span> <span class="o">*</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">-</span> <span class="mi">1</span><span class="p">))</span> <span class="o">+</span> <span class="n">value</span><span class="p">)</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">+=</span> <span class="mi">1</span> </div> <div class="viewcode-block" id="Statistic.get_value"><a class="viewcode-back" href="../../development/plugins.html#Bcfg2.Statistics.Statistic.get_value">[docs]</a> <span class="k">def</span> <span class="nf">get_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="sd">""" Get a tuple of all the stats tracked on this named item.</span> <span class="sd"> The tuple is in the format::</span> <span class="sd"> (<name>, (min, max, average, number of values))</span> <span class="sd"> This makes it very easy to cast to a dict in</span> <span class="sd"> :func:`Statistics.display`.</span> <span class="sd"> :returns: tuple</span> <span class="sd"> """</span> <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">min</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">max</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">ave</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span><span class="p">))</span> </div></div> <div class="viewcode-block" id="Statistics"><a class="viewcode-back" href="../../development/plugins.html#Bcfg2.Statistics.Statistics">[docs]</a><span class="k">class</span> <span class="nc">Statistics</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> <span class="sd">""" A collection of named :class:`Statistic` objects. """</span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> <div class="viewcode-block" id="Statistics.add_value"><a class="viewcode-back" href="../../development/plugins.html#Bcfg2.Statistics.Statistics.add_value">[docs]</a> <span class="k">def</span> <span class="nf">add_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="sd">""" Add a value to the named :class:`Statistic`. This just</span> <span class="sd"> proxies to :func:`Statistic.add_value` or the</span> <span class="sd"> :class:`Statistic` constructor as appropriate.</span> <span class="sd"> :param name: The name of the :class:`Statistic` to add the</span> <span class="sd"> value to</span> <span class="sd"> :type name: string</span> <span class="sd"> :param value: The value to add to the Statistic</span> <span class="sd"> :type value: int or float</span> <span class="sd"> """</span> <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">Statistic</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">add_value</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> </div> <div class="viewcode-block" id="Statistics.display"><a class="viewcode-back" href="../../development/plugins.html#Bcfg2.Statistics.Statistics.display">[docs]</a> <span class="k">def</span> <span class="nf">display</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="sd">""" Return a dict of all :class:`Statistic` object values.</span> <span class="sd"> Keys are the statistic names, and values are tuples of the</span> <span class="sd"> statistic metrics as returned by</span> <span class="sd"> :func:`Statistic.get_value`. """</span> <span class="k">return</span> <span class="nb">dict</span><span class="p">([</span><span class="n">value</span><span class="o">.</span><span class="n">get_value</span><span class="p">()</span> <span class="k">for</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">values</span><span class="p">())])</span> <span class="c">#: A module-level :class:`Statistics` objects used to track all</span> <span class="c">#: execution time metrics for the server.</span></div></div> <span class="n">stats</span> <span class="o">=</span> <span class="n">Statistics</span><span class="p">()</span> <span class="c"># pylint: disable=C0103</span> </pre></div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li><a href="../../index.html">home</a> | </li> <!--<li><a href="../../search.html">search</a> | </li>--> <li><a href="../../help/index.html">help</a> | </li> <li><a href="../../contents.html">documentation </a> »</li> <li><a href="../index.html" >Module code</a> »</li> </ul> </div> <div class="footer"> © Copyright 2009-2013, Narayan Desai. Last updated on Mar 20, 2013. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>