4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief Statistics non-inline non-template implementation */
26 #include "Statistics.hh"
27 //#include "Statistics.ih"
32 #include <senf/Utils/Console/Console.hh>
33 #include <senf/Utils/Format.hh>
34 #include "StatisticsTargets.hh"
36 //#include "Statistics.mpp"
38 ///////////////////////////////cc.p////////////////////////////////////////
40 ///////////////////////////////////////////////////////////////////////////
41 // senf::StatisticsBase
43 prefix_ void senf::StatisticsBase::enter(float min, float avg, float max, float dev)
53 prefix_ senf::Collector & senf::StatisticsBase::operator[](unsigned rank)
55 Children::iterator i (children_.find(rank));
56 if (i == children_.end())
57 throw InvalidRankException();
61 prefix_ senf::Collector & senf::StatisticsBase::collect(unsigned rank)
63 std::pair<Children::iterator, bool> state (
64 children_.insert(std::make_pair(rank, Collector(this, rank))) );
66 throw DuplicateRankException();
67 return state.first->second;
70 prefix_ senf::StatisticsBase::OutputProxy<senf::StatisticsBase>
71 senf::StatisticsBase::output(unsigned n)
73 OutputMap::iterator i (outputs_.find(n));
74 if (i == outputs_.end()) {
75 i = outputs_.insert(std::make_pair(n, OutputEntry(n))).first;
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);
83 return OutputProxy<StatisticsBase>(this, &(i->second));
86 prefix_ void senf::StatisticsBase::consoleList(unsigned level, std::ostream & os)
89 namespace fmt = senf::format;
91 os << boost::format("%s%-5d%|15t| %12.5g %19.5g %12.5g\n")
92 % std::string(2*level,' ') % rank()
93 % fmt::eng(min()).setw() % fmt::eng(avg(),dev()).setw() % fmt::eng(max()).setw();
95 OutputMap::const_iterator i (outputs_.begin());
96 OutputMap::const_iterator i_end (outputs_.end());
97 for (; i != i_end; ++i)
98 os << boost::format(" %3d %12.5g %19.5g %12.5g\n")
100 % fmt::eng(i->second.min).setw()
101 % fmt::eng(i->second.avg, i->second.dev).setw()
102 % fmt::eng(i->second.max).setw();
105 Children::const_iterator i (children_.begin());
106 Children::const_iterator const i_end (children_.end());
107 for (; i != i_end; ++i)
108 i->second.consoleList(level+1, os);
112 prefix_ void senf::StatisticsBase::generateOutput()
114 queue_.push_front(QueueEntry(min_, avg_, max_, dev_));
115 while (queue_.size() > maxQueueLen_)
118 OutputMap::iterator i (outputs_.begin());
119 OutputMap::iterator const i_end (outputs_.end());
120 for (; i != i_end; ++i) {
121 i->second.min = i->second.avg = i->second.max = i->second.dev = 0.0f;
122 Queue::const_iterator j (queue_.begin());
123 Queue::const_iterator const j_end (queue_.end());
125 for (; n < i->second.n && j != j_end; ++n, ++j) {
126 i->second.min += j->min;
127 i->second.avg += j->avg;
128 i->second.max += j->max;
129 i->second.dev += j->dev;
135 i->second.signal(i->second.min, i->second.avg, i->second.max, i->second.dev);
139 prefix_ void senf::StatisticsBase::signalChildren()
141 Children::iterator i (children_.begin());
142 Children::iterator const i_end (children_.end());
143 for (; i != i_end; ++i)
144 i->second.enter(min_, avg_, max_, dev_);
147 ///////////////////////////////////////////////////////////////////////////
150 prefix_ senf::Statistics::Statistics()
151 #ifndef SENF_DISABLE_CONSOLE
155 #ifndef SENF_DISABLE_CONSOLE
156 dir.add("list", &Statistics::consoleList)
157 .doc("List statistics collection intervals and current values.\n"
160 " RANK Number of values collected. Since the statistics collectors form\n"
161 " a tree, the value is indented according to it's tree location.\n"
162 " WIN Size of output average window.\n"
163 " MIN Last entered minimum value.\n"
164 " AVG Last entered average value.\n"
165 " DEV Standard deviation of average value over the collector rank.\n"
166 " MAX Last entered maximum value.");
167 dir.add("collect", &Statistics::consoleCollect)
168 .doc("Add statistics collection groups. The argument gives a sequence of collector\n"
169 "ranks each building on the preceding collector:\n"
171 " $ collect (10 60 60)\n"
173 "Will start by collecting every 10 values together to a new value. 60 of such\n"
174 "combined values will be collected together in the next step again followed by\n"
175 "a collection of 60 values. If the statistics is entered with a frequency of\n"
176 "10 values per second, this will provide combined statistics over the second,\n"
177 "minutes and hours ranges.\n"
179 "You may call collect multiple times. Any missing collection ranks will be\n"
181 .arg("ranks","chain of collector ranks");
182 dir.add("output", &Statistics::consoleOutput)
183 .doc("Generate statistics output. This statement will add an additional output\n"
184 "generator. This generator will be attached to the collector specified by\n"
185 "the {rank} parameter. This parameter is a chain of successive rank values\n"
186 "which specifies the exact collector to use. If the collector does not\n"
187 "exist, it will be created (this is like automatically calling 'collect'\n"
188 "with {rank} as argument).\n"
190 "If the output is to be sent somewhere it must be connected to a statistics\n"
193 "The output may optionally be built using a sliding average over the last\n"
198 "will output the basic statistics value each time a new value is entered.\n"
200 " $ output (10 60) 5\n"
202 "Assuming that new data values are entered 10 times per second, this command\n"
203 "will generate output once every minute. The value will be the average over\n"
204 "the last 5 minutes.")
205 .arg("rank","Rank chain selecting the value to generate output for")
206 .arg("window","Optional size of sliding average window",
207 senf::console::kw::default_value = 1u);
211 prefix_ void senf::Statistics::consoleList(std::ostream & os)
213 os << "RANK WIN MIN AVG MAX\n";
214 StatisticsBase::consoleList(0, os);
217 prefix_ void senf::Statistics::consoleCollect(std::vector<unsigned> & ranks)
219 StatisticsBase * stats (this);
220 std::vector<unsigned>::const_iterator i (ranks.begin());
221 std::vector<unsigned>::const_iterator const i_end (ranks.end());
224 for (; i != i_end; ++i)
225 stats = &(*stats)[*i];
227 catch (InvalidRankException &) {}
229 for (; i != i_end; ++i)
230 stats = & (stats->collect(*i));
234 prefix_ boost::shared_ptr<senf::console::DirectoryNode>
235 senf::Statistics::consoleOutput(std::vector<unsigned> & ranks, unsigned window)
237 StatisticsBase * stats (this);
238 std::vector<unsigned>::const_iterator i (ranks.begin());
239 std::vector<unsigned>::const_iterator const i_end (ranks.end());
242 for (; i != i_end; ++i)
243 stats = &(*stats)[*i];
245 catch (InvalidRankException &) {}
247 for (; i != i_end; ++i)
248 stats = & (stats->collect(*i));
250 return stats->output(window).dir().node().thisptr();
253 prefix_ senf::Statistics & senf::Statistics::v_base()
258 prefix_ std::string senf::Statistics::v_path()
264 ///////////////////////////////////////////////////////////////////////////
267 prefix_ void senf::Collector::enter(float min, float avg, float max, float dev)
270 accSumSq_ += avg*avg + dev*dev;
271 if (min < accMin_) accMin_ = min;
272 if (max > accMax_) accMax_ = max;
274 float accAvg (accSum_ / i_);
275 float accDev (std::sqrt(std::max(0.0f,accSumSq_ / i_ - accAvg*accAvg)));
276 StatisticsBase::enter(accMin_, accAvg, accMax_, accDev);
285 prefix_ senf::Statistics & senf::Collector::v_base()
287 return owner_->base();
290 prefix_ std::string senf::Collector::v_path()
293 return owner_->path() + "-" + senf::str(rank_);
296 ///////////////////////////////cc.e////////////////////////////////////////
298 //#include "Statistics.mpp"
304 // comment-column: 40
305 // c-file-style: "senf"
306 // indent-tabs-mode: nil
307 // ispell-local-dictionary: "american"
308 // compile-command: "scons -u test"