blob: e5c6136cb957d4373bd657a8f8ba60d97bf05df5 (
plain)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_UKM_UKM_SERVICE_H_
#define COMPONENTS_UKM_UKM_SERVICE_H_
#include <stddef.h>
#include <memory>
#include <vector>
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "build/build_config.h"
#include "components/metrics/delegating_provider.h"
#include "components/metrics/metrics_provider.h"
#include "components/metrics/metrics_rotation_scheduler.h"
#include "components/ukm/ukm_recorder_impl.h"
#include "components/ukm/ukm_reporting_service.h"
class PrefRegistrySimple;
class PrefService;
namespace metrics {
class MetricsServiceClient;
class UkmBrowserTestBase;
class UkmEGTestHelper;
}
namespace ukm {
namespace debug {
class UkmDebugDataExtractor;
}
// The URL-Keyed Metrics (UKM) service is responsible for gathering and
// uploading reports that contain fine grained performance metrics including
// URLs for top-level navigations.
class UkmService : public UkmRecorderImpl {
public:
// Constructs a UkmService.
// Calling code is responsible for ensuring that the lifetime of
// |pref_service| is longer than the lifetime of UkmService.
UkmService(PrefService* pref_service,
metrics::MetricsServiceClient* client,
bool restrict_to_whitelist_entries);
~UkmService() override;
// Initializes the UKM service.
void Initialize();
// Enables/disables transmission of accumulated logs. Logs that have already
// been created will remain persisted to disk.
void EnableReporting();
void DisableReporting();
#if defined(OS_ANDROID) || defined(OS_IOS)
void OnAppEnterBackground();
void OnAppEnterForeground();
#endif
// Records any collected data into logs, and writes to disk.
void Flush();
// Deletes any unsent local data.
void Purge();
// Resets the client id stored in prefs.
void ResetClientId();
// Registers the specified |provider| to provide additional metrics into the
// UKM log. Should be called during MetricsService initialization only.
void RegisterMetricsProvider(
std::unique_ptr<metrics::MetricsProvider> provider);
// Registers the names of all of the preferences used by UkmService in
// the provided PrefRegistry.
static void RegisterPrefs(PrefRegistrySimple* registry);
int32_t report_count() const { return report_count_; }
private:
friend ::metrics::UkmBrowserTestBase;
friend ::metrics::UkmEGTestHelper;
friend ::ukm::debug::UkmDebugDataExtractor;
friend ::ukm::UkmUtilsForTest;
// Starts metrics client initialization.
void StartInitTask();
// Called when initialization tasks are complete, to notify the scheduler
// that it can begin calling RotateLog.
void FinishedInitTask();
// Periodically called by scheduler_ to advance processing of logs.
void RotateLog();
// Constructs a new Report from available data and stores it in
// persisted_logs_.
void BuildAndStoreLog();
// Starts an upload of the next log from persisted_logs_.
void StartScheduledUpload();
// Called by log_uploader_ when the an upload is completed.
void OnLogUploadComplete(int response_code);
// ukm::UkmRecorderImpl:
bool ShouldRestrictToWhitelistedEntries() const override;
// A weak pointer to the PrefService used to read and write preferences.
PrefService* pref_service_;
// If true, only whitelisted Entries should be recorded.
bool restrict_to_whitelist_entries_;
// The UKM client id stored in prefs.
uint64_t client_id_;
// The UKM session id stored in prefs.
int32_t session_id_;
// The number of reports generated this session.
int32_t report_count_;
// Used to interact with the embedder. Weak pointer; must outlive |this|
// instance.
metrics::MetricsServiceClient* const client_;
// Registered metrics providers.
metrics::DelegatingProvider metrics_providers_;
// Log reporting service.
ukm::UkmReportingService reporting_service_;
// The scheduler for determining when uploads should happen.
std::unique_ptr<metrics::MetricsRotationScheduler> scheduler_;
SEQUENCE_CHECKER(sequence_checker_);
bool initialize_started_;
bool initialize_complete_;
// Weak pointers factory used to post task on different threads. All weak
// pointers managed by this factory have the same lifetime as UkmService.
base::WeakPtrFactory<UkmService> self_ptr_factory_;
DISALLOW_COPY_AND_ASSIGN(UkmService);
};
} // namespace ukm
#endif // COMPONENTS_UKM_UKM_SERVICE_H_
|
