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"
33 #include <senf/Utils/Format.hh>
34 #include "StatisticsTargets.hh"
36 //#include "Statistics.mpp"
38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
40 //-/////////////////////////////////////////////////////////////////////////////////////////////////
41 // senf::StatisticsBase
43 prefix_ void senf::StatisticsBase::enter(unsigned n, float min, float avg, float max, float dev)
49 for (unsigned i (0); i < n; ++i)
51 Children::iterator i (children_.begin());
52 Children::iterator const i_end (children_.end());
53 for (; i != i_end; ++i)
54 i->second.enter(n, min_, avg_, max_, dev_);
57 prefix_ senf::Collector & senf::StatisticsBase::operator[](unsigned rank)
59 Children::iterator i (children_.find(rank));
60 if (i == children_.end())
61 throw InvalidRankException();
65 prefix_ senf::Collector const & senf::StatisticsBase::operator[](unsigned rank)
68 Children::const_iterator i (children_.find(rank));
69 if (i == children_.end())
70 throw InvalidRankException();
74 prefix_ senf::Collector & senf::StatisticsBase::collect(unsigned rank)
76 std::pair<Children::iterator, bool> state (
77 children_.insert(std::make_pair(rank, Collector(this, rank))) );
79 throw DuplicateRankException();
80 return state.first->second;
83 prefix_ senf::StatisticsBase::OutputProxy<senf::StatisticsBase>
84 senf::StatisticsBase::output(unsigned n)
86 OutputMap::iterator i (outputs_.find(n));
87 if (i == outputs_.end()) {
88 i = outputs_.insert(std::make_pair(n, OutputEntry(n))).first;
90 nm << "output" << path() << ":" << n;
91 base().dir.node().add(nm.str(), i->second.dir);
92 detail::StatisticsLoggerRegistry::instance().apply(*this, n, i->second.dir);
96 return OutputProxy<StatisticsBase>(this, &(i->second));
99 prefix_ void senf::StatisticsBase::consoleList(unsigned level, std::ostream & os)
102 namespace fmt = senf::format;
104 os << boost::format("%s%-5d%|15t| %12.5g %19.5g %12.5g\n")
105 % std::string(2*level,' ') % rank()
106 % fmt::eng(min()).setw() % fmt::eng(avg(),dev()).setw() % fmt::eng(max()).setw();
108 OutputMap::const_iterator i (outputs_.begin());
109 OutputMap::const_iterator i_end (outputs_.end());
110 for (; i != i_end; ++i)
111 os << boost::format(" %3d %12.5g %19.5g %12.5g\n")
113 % fmt::eng(i->second.min).setw()
114 % fmt::eng(i->second.avg, i->second.dev).setw()
115 % fmt::eng(i->second.max).setw();
118 Children::const_iterator i (children_.begin());
119 Children::const_iterator const i_end (children_.end());
120 for (; i != i_end; ++i)
121 i->second.consoleList(level+1, os);
125 prefix_ void senf::StatisticsBase::generateOutput()
127 queue_.push_front(QueueEntry(min_, avg_, max_, dev_));
128 while (queue_.size() > maxQueueLen_)
131 OutputMap::iterator i (outputs_.begin());
132 OutputMap::iterator const i_end (outputs_.end());
133 for (; i != i_end; ++i) {
134 i->second.min = i->second.avg = i->second.max = i->second.dev = 0.0f;
135 Queue::const_iterator j (queue_.begin());
136 Queue::const_iterator const j_end (queue_.end());
138 for (; n < i->second.n && j != j_end; ++n, ++j) {
139 i->second.min += j->min;
140 i->second.avg += j->avg;
141 i->second.max += j->max;
142 i->second.dev += j->dev;
148 i->second.signal(i->second.min, i->second.avg, i->second.max, i->second.dev);
152 //-/////////////////////////////////////////////////////////////////////////////////////////////////
155 prefix_ senf::Statistics::Statistics()
156 #ifndef SENF_DISABLE_CONSOLE
160 #ifndef SENF_DISABLE_CONSOLE
161 namespace fty = senf::console::factory;
163 dir.add("list", fty::Command(&Statistics::consoleList, this)
164 .doc("List statistics collection intervals and current values.\n"
167 " RANK Number of values collected. Since the statistics collectors form\n"
168 " a tree, the value is indented according to it's tree location.\n"
169 " WIN Size of output average window.\n"
170 " MIN Last entered minimum value.\n"
171 " AVG Last entered average value.\n"
172 " DEV Standard deviation of average value over the collector rank.\n"
173 " MAX Last entered maximum value.") );
174 dir.add("collect", fty::Command(&Statistics::consoleCollect, this)
175 .doc("Add statistics collection groups. The argument gives a sequence of collector\n"
176 "ranks each building on the preceding collector:\n"
178 " $ collect (10 60 60)\n"
180 "Will start by collecting every 10 values together to a new value. 60 of such\n"
181 "combined values will be collected together in the next step again followed by\n"
182 "a collection of 60 values. If the statistics is entered with a frequency of\n"
183 "10 values per second, this will provide combined statistics over the second,\n"
184 "minutes and hours ranges.\n"
186 "You may call collect multiple times. Any missing collection ranks will be\n"
188 .arg("ranks","chain of collector ranks") );
189 dir.add("output", fty::Command(&Statistics::consoleOutput, this)
190 .doc("Generate statistics output. This statement will add an additional output\n"
191 "generator. This generator will be attached to the collector specified by\n"
192 "the {rank} parameter. This parameter is a chain of successive rank values\n"
193 "which specifies the exact collector to use. If the collector does not\n"
194 "exist, it will be created (this is like automatically calling 'collect'\n"
195 "with {rank} as argument).\n"
197 "If the output is to be sent somewhere it must be connected to a statistics\n"
200 "The output may optionally be built using a sliding average over the last\n"
205 "will output the basic statistics value each time a new value is entered.\n"
207 " $ output (10 60) 5\n"
209 "Assuming that new data values are entered 10 times per second, this command\n"
210 "will generate output once every minute. The value will be the average over\n"
211 "the last 5 minutes.")
212 .arg("rank","Rank chain selecting the value to generate output for")
213 .arg("window","Optional size of sliding average window",
214 senf::console::kw::default_value = 1u) );
218 prefix_ void senf::Statistics::consoleList(std::ostream & os)
220 os << "RANK WIN MIN AVG MAX\n";
221 StatisticsBase::consoleList(0, os);
224 prefix_ void senf::Statistics::consoleCollect(std::vector<unsigned> & ranks)
226 StatisticsBase * stats (this);
227 std::vector<unsigned>::const_iterator i (ranks.begin());
228 std::vector<unsigned>::const_iterator const i_end (ranks.end());
231 for (; i != i_end; ++i)
232 stats = &(*stats)[*i];
234 catch (InvalidRankException &) {}
236 for (; i != i_end; ++i)
237 stats = & (stats->collect(*i));
241 prefix_ boost::shared_ptr<senf::console::DirectoryNode>
242 senf::Statistics::consoleOutput(std::vector<unsigned> & ranks, unsigned window)
244 StatisticsBase * stats (this);
245 std::vector<unsigned>::const_iterator i (ranks.begin());
246 std::vector<unsigned>::const_iterator const i_end (ranks.end());
249 for (; i != i_end; ++i)
250 stats = &(*stats)[*i];
252 catch (InvalidRankException &) {}
254 for (; i != i_end; ++i)
255 stats = & (stats->collect(*i));
257 return stats->output(window).dir().node().thisptr();
260 prefix_ senf::Statistics & senf::Statistics::v_base()
265 prefix_ std::string senf::Statistics::v_path()
271 //-/////////////////////////////////////////////////////////////////////////////////////////////////
274 prefix_ void senf::Collector::enter(unsigned n, float min, float avg, float max, float dev)
276 if (min < accMin_) accMin_ = min;
277 if (max > accMax_) accMax_ = max;
279 if (i_ + n >= rank_) {
280 accSum_ += (rank_-i_)*avg;
281 accSumSq_ += (rank_-i_)*(rank_-i_)*(avg*avg + dev*dev);
282 float accAvg (accSum_ / rank_);
283 float accDev (std::sqrt(std::max(0.0f,accSumSq_ / rank_ - accAvg*accAvg)));
284 StatisticsBase::enter(1, accMin_, accAvg, accMax_, accDev);
293 std::div_t d (std::div(int(n), int(rank_)));
294 StatisticsBase::enter(d.quot, min, avg, max, dev);
301 accSumSq_ += n*n*(avg*avg+dev*dev);
303 if (min < accMin_) accMin_ = min;
304 if (max > accMax_) accMax_ = max;
308 prefix_ senf::Statistics & senf::Collector::v_base()
310 return owner_->base();
313 prefix_ std::string senf::Collector::v_path()
316 return owner_->path() + "-" + senf::str(rank_);
319 //-/////////////////////////////////////////////////////////////////////////////////////////////////
321 //#include "Statistics.mpp"
327 // comment-column: 40
328 // c-file-style: "senf"
329 // indent-tabs-mode: nil
330 // ispell-local-dictionary: "american"
331 // compile-command: "scons -u test"