senf/Utils/Statistics.cc

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief Statistics non-inline non-template implementation */
  25
  26 #include "Statistics.hh"
  27 //#include "Statistics.ih"
  28
  29 // Custom includes
  30 #include <cmath>
  31 #include <sstream>
  32 #include <senf/Utils/Console/Console.hh>
  33 #include <senf/Utils/Format.hh>
  34 #include "StatisticsTargets.hh"
  35
  36 //#include "Statistics.mpp"
  37 #define prefix_
  38 ///////////////////////////////cc.p////////////////////////////////////////
  39
  40 ///////////////////////////////////////////////////////////////////////////
  41 // senf::StatisticsBase
  42
  43 prefix_ void senf::StatisticsBase::enter(float min, float avg, float max, float dev)
  44 {
  45     min_ = min;
  46     avg_ = avg;
  47     max_ = max;
  48     dev_ = dev;
  49     generateOutput();
  50     signalChildren();
  51 }
  52
  53 prefix_ senf::Collector & senf::StatisticsBase::operator[](unsigned rank)
  54 {
  55     Children::iterator i (children_.find(rank));
  56     if (i == children_.end())
  57         throw InvalidRankException();
  58     return i->second;
  59 }
  60
  61 prefix_ senf::Collector & senf::StatisticsBase::collect(unsigned rank)
  62 {
  63     std::pair<Children::iterator, bool> state (
  64         children_.insert(std::make_pair(rank, Collector(this, rank))) );
  65     if (! state.second)
  66         throw DuplicateRankException();
  67     return state.first->second;
  68 }
  69
  70 prefix_ senf::StatisticsBase::OutputProxy<senf::StatisticsBase>
  71 senf::StatisticsBase::output(unsigned n)
  72 {
  73     OutputMap::iterator i (outputs_.find(n));
  74     if (i == outputs_.end()) {
  75         i = outputs_.insert(std::make_pair(n, OutputEntry(n))).first;
  76         std::stringstream nm;
  77         nm << "output" << path() << ":" << n;
  78         base().dir.node().add(nm.str(), i->second.dir);
  79         detail::StatisticsLoggerRegistry::instance().apply(*this, n, i->second.dir);
  80     }
  81     if (n > maxQueueLen_)
  82         maxQueueLen_ = n;
  83     return OutputProxy<StatisticsBase>(this, &(i->second));
  84 }
  85
  86 prefix_ void senf::StatisticsBase::consoleList(unsigned level, std::ostream & os)
  87     const
  88 {
  89     os << boost::format("%s%-5d%|15t|  %12s  %19.5g  %12s\n")
  90         % std::string(2*level,' ')
  91         % rank()
  92         % boost::io::group(std::setw(1),senf::format::eng(min()))
  93         % boost::io::group(std::setw(1),senf::format::eng(avg(),dev()))
  94         % boost::io::group(std::setw(1),senf::format::eng(max()));
  95     {
  96         OutputMap::const_iterator i (outputs_.begin());
  97         OutputMap::const_iterator i_end (outputs_.end());
  98         for (; i != i_end; ++i)
  99             os << boost::format("            %3d  %12s  %19.5g  %12s\n")
 100                 % i->second.n
 101                 % boost::io::group(std::setw(1),senf::format::eng(i->second.min/i->second.n))
 102                 % boost::io::group(std::setw(1),senf::format::eng(i->second.avg/i->second.n,
 103                                                                   i->second.dev/i->second.n))
 104                 % boost::io::group(std::setw(1),senf::format::eng(i->second.max/i->second.n));
 105     }
 106     {
 107         Children::const_iterator i (children_.begin());
 108         Children::const_iterator const i_end (children_.end());
 109         for (; i != i_end; ++i)
 110             i->second.consoleList(level+1, os);
 111     }
 112 }
 113
 114 prefix_ void senf::StatisticsBase::generateOutput()
 115 {
 116     queue_.push_front(QueueEntry(min_, avg_, max_, dev_));
 117     while (queue_.size() > maxQueueLen_)
 118         queue_.pop_back();
 119
 120     OutputMap::iterator i (outputs_.begin());
 121     OutputMap::iterator const i_end (outputs_.end());
 122     for (; i != i_end; ++i) {
 123         i->second.min = i->second.avg = i->second.max = i->second.dev = 0.0f;
 124         Queue::const_iterator j (queue_.begin());
 125         Queue::const_iterator const j_end (queue_.end());
 126         unsigned n (0);
 127         for (; n < i->second.n && j != j_end; ++n, ++j) {
 128             i->second.min += j->min;
 129             i->second.avg += j->avg;
 130             i->second.max += j->max;
 131             i->second.dev += j->dev;
 132         }
 133         i->second.signal(i->second.min/n, i->second.avg/n, i->second.max/n, i->second.dev/n);
 134     }
 135 }
 136
 137 prefix_ void senf::StatisticsBase::signalChildren()
 138 {
 139     Children::iterator i (children_.begin());
 140     Children::iterator const i_end  (children_.end());
 141     for (; i != i_end; ++i)
 142         i->second.enter(min_, avg_, max_, dev_);
 143 }
 144
 145 ///////////////////////////////////////////////////////////////////////////
 146 // senf::Statistics
 147
 148 prefix_ senf::Statistics::Statistics()
 149 #ifndef SENF_DISABLE_CONSOLE
 150     : dir (this)
 151 #endif
 152 {
 153 #ifndef SENF_DISABLE_CONSOLE
 154     dir.add("list", &Statistics::consoleList)
 155         .doc("List statistics collection intervals and current values.\n"
 156              "\n"
 157              "Columns:\n"
 158              "    RANK    Number of values collected. Since the statistics collectors form\n"
 159              "            a tree, the value is indented according to it's tree location.\n"
 160              "    WIN     Size of output average window.\n"
 161              "    MIN     Last entered minimum value.\n"
 162              "    AVG     Last entered average value.\n"
 163              "    DEV     Standard deviation of average value over the collector rank.\n"
 164              "    MAX     Last entered maximum value.");
 165     dir.add("collect", &Statistics::consoleCollect)
 166         .doc("Add statistics collection groups. The argument gives a sequence of collector\n"
 167              "ranks each building on the preceding collector:\n"
 168              "\n"
 169              "    $ collect (10 60 60)\n"
 170              "\n"
 171              "Will start by collecting every 10 values together to a new value. 60 of such\n"
 172              "combined values will be collected together in the next step again followed by\n"
 173              "a collection of 60 values. If the statistics is entered with a frequency of\n"
 174              "10 values per second, this will provide combined statistics over the second,\n"
 175              "minutes and hours ranges.\n"
 176              "\n"
 177              "You may call collect multiple times. Any missing collection ranks will be\n"
 178              "added.")
 179         .arg("ranks","chain of collector ranks");
 180     dir.add("output", &Statistics::consoleOutput)
 181         .doc("Generate statistics output. This statement will add an additional output\n"
 182              "generator. This generator will be attached to the collector specified by\n"
 183              "the {rank} parameter. This parameter is a chain of successive rank values\n"
 184              "which specifies the exact collector to use. If the collector does not\n"
 185              "exist, it will be created (this is like automatically calling 'collect'\n"
 186              "with {rank} as argument).\n"
 187              "\n"
 188              "If the output is to be sent somewhere it must be connected to a statistics\n"
 189              "target.\n"
 190              "\n"
 191              "The output may optionally be built using a sliding average over the last\n"
 192              "{window} values.\n"
 193              "\n"
 194              "    $ output ()\n"
 195              "\n"
 196              "will output the basic statistics value each time a new value is entered.\n"
 197              "\n"
 198              "    $ output (10 60) 5\n"
 199              "\n"
 200              "Assuming that new data values are entered 10 times per second, this command\n"
 201              "will generate output once every minute. The value will be the average over\n"
 202              "the last 5 minutes.")
 203         .arg("rank","Rank chain selecting the value to generate output for")
 204         .arg("window","Optional size of sliding average window",
 205              senf::console::kw::default_value = 1u);
 206 #endif
 207 }
 208
 209 prefix_ void senf::Statistics::consoleList(std::ostream & os)
 210 {
 211     os << "RANK        WIN           MIN                  AVG           MAX\n";
 212     StatisticsBase::consoleList(0, os);
 213 }
 214
 215 prefix_ void senf::Statistics::consoleCollect(std::vector<unsigned> & ranks)
 216 {
 217     StatisticsBase * stats (this);
 218     std::vector<unsigned>::const_iterator i (ranks.begin());
 219     std::vector<unsigned>::const_iterator const i_end (ranks.end());
 220
 221     try {
 222         for (; i != i_end; ++i)
 223             stats = &(*stats)[*i];
 224     }
 225     catch (InvalidRankException &) {}
 226
 227     for (; i != i_end; ++i)
 228         stats = & (stats->collect(*i));
 229
 230 }
 231
 232 prefix_  boost::shared_ptr<senf::console::DirectoryNode>
 233 senf::Statistics::consoleOutput(std::vector<unsigned> & ranks, unsigned window)
 234 {
 235     StatisticsBase * stats (this);
 236     std::vector<unsigned>::const_iterator i (ranks.begin());
 237     std::vector<unsigned>::const_iterator const i_end (ranks.end());
 238
 239     try {
 240         for (; i != i_end; ++i)
 241             stats = &(*stats)[*i];
 242     }
 243     catch (InvalidRankException &) {}
 244
 245     for (; i != i_end; ++i)
 246         stats = & (stats->collect(*i));
 247
 248     return stats->output(window).dir().node().thisptr();
 249 }
 250
 251 prefix_ senf::Statistics & senf::Statistics::v_base()
 252 {
 253     return *this;
 254 }
 255
 256 prefix_ std::string senf::Statistics::v_path()
 257     const
 258 {
 259     return "";
 260 }
 261
 262 ///////////////////////////////////////////////////////////////////////////
 263 // senf::Collector
 264
 265 prefix_ void senf::Collector::enter(float min, float avg, float max, float dev)
 266 {
 267     accSum_ += avg;
 268     accSumSq_ += avg*avg + dev*dev;
 269     if (min < accMin_) accMin_ = min;
 270     if (max > accMax_) accMax_ = max;
 271     if (++i_ >= rank_) {
 272         float accAvg (accSum_ / i_);
 273         float accDev (std::sqrt(accSumSq_ / i_ - accAvg*accAvg));
 274         StatisticsBase::enter(accMin_, accAvg, accMax_, accDev);
 275         i_ = 0;
 276         accMin_ = FLT_MAX;
 277         accSum_ = 0.0f;
 278         accSumSq_ = 0.0f;
 279         accMax_ = -FLT_MAX;
 280     }
 281 }
 282
 283 prefix_ senf::Statistics & senf::Collector::v_base()
 284 {
 285     return owner_->base();
 286 }
 287
 288 prefix_ std::string senf::Collector::v_path()
 289     const
 290 {
 291     return owner_->path() + "-" + senf::str(rank_);
 292 }
 293
 294 ///////////////////////////////cc.e////////////////////////////////////////
 295 #undef prefix_
 296 //#include "Statistics.mpp"
 297
 298 \f
 299 // Local Variables:
 300 // mode: c++
 301 // fill-column: 100
 302 // comment-column: 40
 303 // c-file-style: "senf"
 304 // indent-tabs-mode: nil
 305 // ispell-local-dictionary: "american"
 306 // compile-command: "scons -u test"
 307 // End: