1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_METRICS_METRICS_SERVICE_ACCESSOR_H_
#define COMPONENTS_METRICS_METRICS_SERVICE_ACCESSOR_H_
#include <stdint.h>
#include <string_view>
#include "components/variations/synthetic_trials.h"
class PrefService;
namespace metrics {
class MetricsService;
// This class limits and documents access to metrics service helper methods.
// These methods are protected so each user has to inherit own program-specific
// specialization and enable access there by declaring friends.
class MetricsServiceAccessor {
public:
MetricsServiceAccessor(const MetricsServiceAccessor&) = delete;
MetricsServiceAccessor& operator=(const MetricsServiceAccessor&) = delete;
// Returns the value assigned by
// SetForceIsMetricsReportingEnabledPrefLookup(). Default value is false.
static bool IsForceMetricsReportingEnabledPrefLookup();
protected:
// Constructor declared as protected to enable inheritance. Descendants should
// disallow instantiation.
MetricsServiceAccessor() = default;
// Returns whether metrics reporting is enabled, using the value of the
// kMetricsReportingEnabled pref in |local_state| to determine whether user
// has enabled reporting.
static bool IsMetricsReportingEnabled(PrefService* local_state);
// Registers a field trial name and group with |metrics_service| (if not
// null), to be used to annotate a UMA report with a particular configuration
// state. The |annotation_mode| parameter determines when UMA reports should
// start being annotated with this trial and group. Returns true on success.
// See the comment on SyntheticTrialRegistry::RegisterSyntheticFieldTrial()
// and ChromeMetricsServiceAccessor::RegisterSyntheticFieldTrial() for more
// details.
static bool RegisterSyntheticFieldTrial(
MetricsService* metrics_service,
std::string_view trial_name,
std::string_view group_name,
variations::SyntheticTrialAnnotationMode annotation_mode);
// IsMetricsReportingEnabled() in non-official builds unconditionally returns
// false. This results in different behavior for tests running in official vs
// non-official builds. To get consistent behavior call this with true, which
// forces non-official builds to look at the prefs value official builds look
// at.
static void SetForceIsMetricsReportingEnabledPrefLookup(bool value);
};
} // namespace metrics
#endif // COMPONENTS_METRICS_METRICS_SERVICE_ACCESSOR_H_
|
