xref: /aosp_15_r20/external/libchrome/base/metrics/single_sample_metrics.cc (revision 635a864187cb8b6c713ff48b7e790a6b21769273)
1*635a8641SAndroid Build Coastguard Worker // Copyright 2017 The Chromium Authors. All rights reserved.
2*635a8641SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*635a8641SAndroid Build Coastguard Worker // found in the LICENSE file.
4*635a8641SAndroid Build Coastguard Worker 
5*635a8641SAndroid Build Coastguard Worker #include "base/metrics/single_sample_metrics.h"
6*635a8641SAndroid Build Coastguard Worker 
7*635a8641SAndroid Build Coastguard Worker #include "base/memory/ptr_util.h"
8*635a8641SAndroid Build Coastguard Worker #include "base/metrics/histogram.h"
9*635a8641SAndroid Build Coastguard Worker 
10*635a8641SAndroid Build Coastguard Worker namespace base {
11*635a8641SAndroid Build Coastguard Worker 
12*635a8641SAndroid Build Coastguard Worker static SingleSampleMetricsFactory* g_factory = nullptr;
13*635a8641SAndroid Build Coastguard Worker 
14*635a8641SAndroid Build Coastguard Worker // static
Get()15*635a8641SAndroid Build Coastguard Worker SingleSampleMetricsFactory* SingleSampleMetricsFactory::Get() {
16*635a8641SAndroid Build Coastguard Worker   if (!g_factory)
17*635a8641SAndroid Build Coastguard Worker     g_factory = new DefaultSingleSampleMetricsFactory();
18*635a8641SAndroid Build Coastguard Worker 
19*635a8641SAndroid Build Coastguard Worker   return g_factory;
20*635a8641SAndroid Build Coastguard Worker }
21*635a8641SAndroid Build Coastguard Worker 
22*635a8641SAndroid Build Coastguard Worker // static
SetFactory(std::unique_ptr<SingleSampleMetricsFactory> factory)23*635a8641SAndroid Build Coastguard Worker void SingleSampleMetricsFactory::SetFactory(
24*635a8641SAndroid Build Coastguard Worker     std::unique_ptr<SingleSampleMetricsFactory> factory) {
25*635a8641SAndroid Build Coastguard Worker   DCHECK(!g_factory);
26*635a8641SAndroid Build Coastguard Worker   g_factory = factory.release();
27*635a8641SAndroid Build Coastguard Worker }
28*635a8641SAndroid Build Coastguard Worker 
29*635a8641SAndroid Build Coastguard Worker // static
DeleteFactoryForTesting()30*635a8641SAndroid Build Coastguard Worker void SingleSampleMetricsFactory::DeleteFactoryForTesting() {
31*635a8641SAndroid Build Coastguard Worker   DCHECK(g_factory);
32*635a8641SAndroid Build Coastguard Worker   delete g_factory;
33*635a8641SAndroid Build Coastguard Worker   g_factory = nullptr;
34*635a8641SAndroid Build Coastguard Worker }
35*635a8641SAndroid Build Coastguard Worker 
36*635a8641SAndroid Build Coastguard Worker std::unique_ptr<SingleSampleMetric>
CreateCustomCountsMetric(const std::string & histogram_name,HistogramBase::Sample min,HistogramBase::Sample max,uint32_t bucket_count)37*635a8641SAndroid Build Coastguard Worker DefaultSingleSampleMetricsFactory::CreateCustomCountsMetric(
38*635a8641SAndroid Build Coastguard Worker     const std::string& histogram_name,
39*635a8641SAndroid Build Coastguard Worker     HistogramBase::Sample min,
40*635a8641SAndroid Build Coastguard Worker     HistogramBase::Sample max,
41*635a8641SAndroid Build Coastguard Worker     uint32_t bucket_count) {
42*635a8641SAndroid Build Coastguard Worker   return std::make_unique<DefaultSingleSampleMetric>(
43*635a8641SAndroid Build Coastguard Worker       histogram_name, min, max, bucket_count,
44*635a8641SAndroid Build Coastguard Worker       HistogramBase::kUmaTargetedHistogramFlag);
45*635a8641SAndroid Build Coastguard Worker }
46*635a8641SAndroid Build Coastguard Worker 
DefaultSingleSampleMetric(const std::string & histogram_name,HistogramBase::Sample min,HistogramBase::Sample max,uint32_t bucket_count,int32_t flags)47*635a8641SAndroid Build Coastguard Worker DefaultSingleSampleMetric::DefaultSingleSampleMetric(
48*635a8641SAndroid Build Coastguard Worker     const std::string& histogram_name,
49*635a8641SAndroid Build Coastguard Worker     HistogramBase::Sample min,
50*635a8641SAndroid Build Coastguard Worker     HistogramBase::Sample max,
51*635a8641SAndroid Build Coastguard Worker     uint32_t bucket_count,
52*635a8641SAndroid Build Coastguard Worker     int32_t flags)
53*635a8641SAndroid Build Coastguard Worker     : histogram_(Histogram::FactoryGet(histogram_name,
54*635a8641SAndroid Build Coastguard Worker                                        min,
55*635a8641SAndroid Build Coastguard Worker                                        max,
56*635a8641SAndroid Build Coastguard Worker                                        bucket_count,
57*635a8641SAndroid Build Coastguard Worker                                        flags)) {
58*635a8641SAndroid Build Coastguard Worker   // Bad construction parameters may lead to |histogram_| being null; DCHECK to
59*635a8641SAndroid Build Coastguard Worker   // find accidental errors in production. We must still handle the nullptr in
60*635a8641SAndroid Build Coastguard Worker   // destruction though since this construction may come from another untrusted
61*635a8641SAndroid Build Coastguard Worker   // process.
62*635a8641SAndroid Build Coastguard Worker   DCHECK(histogram_);
63*635a8641SAndroid Build Coastguard Worker }
64*635a8641SAndroid Build Coastguard Worker 
~DefaultSingleSampleMetric()65*635a8641SAndroid Build Coastguard Worker DefaultSingleSampleMetric::~DefaultSingleSampleMetric() {
66*635a8641SAndroid Build Coastguard Worker   // |histogram_| may be nullptr if bad construction parameters are given.
67*635a8641SAndroid Build Coastguard Worker   if (sample_ < 0 || !histogram_)
68*635a8641SAndroid Build Coastguard Worker     return;
69*635a8641SAndroid Build Coastguard Worker   histogram_->Add(sample_);
70*635a8641SAndroid Build Coastguard Worker }
71*635a8641SAndroid Build Coastguard Worker 
SetSample(HistogramBase::Sample sample)72*635a8641SAndroid Build Coastguard Worker void DefaultSingleSampleMetric::SetSample(HistogramBase::Sample sample) {
73*635a8641SAndroid Build Coastguard Worker   DCHECK_GE(sample, 0);
74*635a8641SAndroid Build Coastguard Worker   sample_ = sample;
75*635a8641SAndroid Build Coastguard Worker }
76*635a8641SAndroid Build Coastguard Worker 
77*635a8641SAndroid Build Coastguard Worker }  // namespace base
78