15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// StatisticsRecorder holds all Histograms and BucketRanges that are used by 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Histograms in the system. It provides a general place for 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Histograms/BucketRanges to register, and supports a global API for accessing 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (i.e., dumping, or graphing) the data. 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_METRICS_STATISTICS_RECORDER_H_ 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_METRICS_STATISTICS_RECORDER_H_ 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <list> 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/base_export.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/gtest_prod_util.h" 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/lazy_instance.h" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BucketRanges; 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class HistogramBase; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Lock; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BASE_EXPORT StatisticsRecorder { 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) typedef std::vector<HistogramBase*> Histograms; 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 33a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // Initializes the StatisticsRecorder system. Safe to call multiple times. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void Initialize(); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find out if histograms can now be registered into our list. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool IsActive(); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Register, or add a new histogram to the collection of statistics. If an 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // identically named histogram is already registered, then the argument 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |histogram| will deleted. The returned value is always the registered 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // histogram (either the argument, or the pre-existing registered histogram). 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static HistogramBase* RegisterOrDeleteDuplicate(HistogramBase* histogram); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Register, or add a new BucketRanges. If an identically BucketRanges is 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // already registered, then the argument |ranges| will deleted. The returned 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // value is always the registered BucketRanges (either the argument, or the 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // pre-existing one). 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const BucketRanges* RegisterOrDeleteDuplicateRanges( 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BucketRanges* ranges); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 52f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Methods for appending histogram data to a string. Only histograms which 53f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // have |query| as a substring are written to |output| (an empty string will 54f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // process all registered histograms). 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void WriteHTMLGraph(const std::string& query, std::string* output); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void WriteGraph(const std::string& query, std::string* output); 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 58f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Returns the histograms with |query| as a substring as JSON text (an empty 59f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // |query| will process all registered histograms). 60f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) static std::string ToJSON(const std::string& query); 61f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Method for extracting histograms which were marked for use by UMA. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void GetHistograms(Histograms* output); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Method for extracting BucketRanges used by all histograms registered. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void GetBucketRanges(std::vector<const BucketRanges*>* output); 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find a histogram by name. It matches the exact name. This method is thread 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // safe. It returns NULL if a matching histogram is not found. 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static HistogramBase* FindHistogram(const std::string& name); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // GetSnapshot copies some of the pointers to registered histograms into the 735d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // caller supplied vector (Histograms). Only histograms which have |query| as 745d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // a substring are copied (an empty string will process all registered 755d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // histograms). 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void GetSnapshot(const std::string& query, Histograms* snapshot); 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We keep all registered histograms in a map, from name to histogram. 802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) typedef std::map<std::string, HistogramBase*> HistogramMap; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We keep all |bucket_ranges_| in a map, from checksum to a list of 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |bucket_ranges_|. Checksum is calculated from the |ranges_| in 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |bucket_ranges_|. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<uint32, std::list<const BucketRanges*>*> RangesMap; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend struct DefaultLazyInstanceTraits<StatisticsRecorder>; 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class HistogramBaseTest; 895d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) friend class HistogramSnapshotManagerTest; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class HistogramTest; 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class SparseHistogramTest; 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class StatisticsRecorderTest; 931e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(HistogramDeltaSerializationTest, 941e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) DeserializeHistogramAndAddSamples); 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The constructor just initializes static members. Usually client code should 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // use Initialize to do this. But in test code, you can friend this class and 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // call destructor/constructor to get a clean StatisticsRecorder. 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) StatisticsRecorder(); 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~StatisticsRecorder(); 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 102c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) static void DumpHistogramsToVlog(void* instance); 103c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static HistogramMap* histograms_; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static RangesMap* ranges_; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Lock protects access to above maps. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static base::Lock* lock_; 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(StatisticsRecorder); 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace base 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_METRICS_STATISTICS_RECORDER_H_ 116