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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
// Copyright (c) 2010 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.
#include "chrome/browser/chromeos/external_metrics.h"
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/file.h>
#include <sys/stat.h>
#include <sys/types.h>
#include "base/basictypes.h"
#include "base/eintr_wrapper.h"
#include "base/histogram.h"
#include "base/perftimer.h"
#include "base/time.h"
#include "chrome/browser/chrome_thread.h"
#include "chrome/browser/metrics/user_metrics.h"
// Steps to add an action.
//
// 1. Enter a helper function that calls UserMetrics::RecordAction.
//
// 2. Add a line for that function in InitializeUserActions.
//
// 3. Enjoy the recompilation.
//
// TODO(semenzato): should see if it is possible to avoid recompiling code
// every time a new user action is added, and register it in some other way.
namespace chromeos {
// The interval between external metrics collections, in milliseconds.
static const int kExternalMetricsCollectionIntervalMs = 30 * 1000;
// There is one of the following functions for every user action as we have to
// call RecordAction in a way that gets picked up by the processing scripts.
static void RecordTabOverviewKeystroke() {
UserMetrics::RecordAction(UserMetricsAction("TabOverview_Keystroke"));
}
static void RecordTabOverviewExitMouse() {
UserMetrics::RecordAction(UserMetricsAction("TabOverview_ExitMouse"));
}
void ExternalMetrics::Start() {
InitializeUserActions();
ScheduleCollector();
}
void ExternalMetrics::DefineUserAction(const std::string& name,
RecordFunctionType f) {
DCHECK(action_recorders_.find(name) == action_recorders_.end());
action_recorders_[name] = f;
}
void ExternalMetrics::InitializeUserActions() {
DefineUserAction("TabOverviewExitMouse", RecordTabOverviewExitMouse);
DefineUserAction("TabOverviewKeystroke", RecordTabOverviewKeystroke);
}
void ExternalMetrics::RecordActionUI(std::string action_string) {
base::hash_map<std::string, RecordFunctionType>::const_iterator iterator;
iterator = action_recorders_.find(action_string);
if (iterator == action_recorders_.end()) {
LOG(ERROR) << "undefined UMA action: " << action_string;
} else {
iterator->second();
}
}
void ExternalMetrics::RecordAction(const char* action) {
std::string action_string(action);
ChromeThread::PostTask(
ChromeThread::UI, FROM_HERE,
NewRunnableMethod(this, &ExternalMetrics::RecordActionUI, action));
}
void ExternalMetrics::RecordHistogram(const char* histogram_data) {
int sample, min, max, nbuckets;
char name[128]; // length must be consistent with sscanf format below.
int n = sscanf(histogram_data, "%127s %d %d %d %d",
name, &sample, &min, &max, &nbuckets);
if (n != 5) {
LOG(ERROR) << "bad histogram request: " << histogram_data;
return;
}
// Do not use the UMA_HISTOGRAM_... macros here. They cache the Histogram
// instance and thus only work if |name| is constant.
scoped_refptr<Histogram> counter = Histogram::FactoryGet(
name, min, max, nbuckets, Histogram::kUmaTargetedHistogramFlag);
counter->Add(sample);
}
void ExternalMetrics::RecordLinearHistogram(const char* histogram_data) {
int sample, max;
char name[128]; // length must be consistent with sscanf format below.
int n = sscanf(histogram_data, "%127s %d %d", name, &sample, &max);
if (n != 3) {
LOG(ERROR) << "bad linear histogram request: " << histogram_data;
return;
}
// Do not use the UMA_HISTOGRAM_... macros here. They cache the Histogram
// instance and thus only work if |name| is constant.
scoped_refptr<Histogram> counter = LinearHistogram::FactoryGet(
name, 1, max, max + 1, Histogram::kUmaTargetedHistogramFlag);
counter->Add(sample);
}
void ExternalMetrics::CollectEvents() {
const char* event_file_path = "/var/log/metrics/uma-events";
struct stat stat_buf;
int result;
if (!test_path_.empty()) {
event_file_path = test_path_.value().c_str();
}
result = stat(event_file_path, &stat_buf);
if (result < 0) {
if (errno != ENOENT) {
PLOG(ERROR) << event_file_path << ": bad metrics file stat";
}
// Nothing to collect---try later.
return;
}
if (stat_buf.st_size == 0) {
// Also nothing to collect.
return;
}
int fd = open(event_file_path, O_RDWR);
if (fd < 0) {
PLOG(ERROR) << event_file_path << ": cannot open";
return;
}
result = flock(fd, LOCK_EX);
if (result < 0) {
PLOG(ERROR) << event_file_path << ": cannot lock";
close(fd);
return;
}
// This processes all messages in the log. Each message starts with a 4-byte
// field containing the length of the entire message. The length is followed
// by a name-value pair of null-terminated strings. When all messages are
// read and processed, or an error occurs, truncate the file to zero size.
for (;;) {
int32 message_size;
result = HANDLE_EINTR(read(fd, &message_size, sizeof(message_size)));
if (result < 0) {
PLOG(ERROR) << "reading metrics message header";
break;
}
if (result == 0) { // normal EOF
break;
}
if (result < static_cast<int>(sizeof(message_size))) {
LOG(ERROR) << "bad read size " << result <<
", expecting " << sizeof(message_size);
break;
}
// kMetricsMessageMaxLength applies to the entire message: the 4-byte
// length field and the two null-terminated strings.
if (message_size < 2 + static_cast<int>(sizeof(message_size)) ||
message_size > static_cast<int>(kMetricsMessageMaxLength)) {
LOG(ERROR) << "bad message size " << message_size;
break;
}
message_size -= sizeof(message_size); // already read this much
uint8 buffer[kMetricsMessageMaxLength];
result = HANDLE_EINTR(read(fd, buffer, message_size));
if (result < 0) {
PLOG(ERROR) << "reading metrics message body";
break;
}
if (result < message_size) {
LOG(ERROR) << "message too short: length " << result <<
", expected " << message_size;
break;
}
// The buffer should now contain a pair of null-terminated strings.
uint8* p = reinterpret_cast<uint8*>(memchr(buffer, '\0', message_size));
uint8* q = NULL;
if (p != NULL) {
q = reinterpret_cast<uint8*>(
memchr(p + 1, '\0', message_size - (p + 1 - buffer)));
}
if (q == NULL) {
LOG(ERROR) << "bad name-value pair for metrics";
break;
} else {
char* name = reinterpret_cast<char*>(buffer);
char* value = reinterpret_cast<char*>(p + 1);
if (test_recorder_ != NULL) {
test_recorder_(name, value);
} else if (strcmp(name, "histogram") == 0) {
RecordHistogram(value);
} else if (strcmp(name, "linearhistogram") == 0) {
RecordLinearHistogram(value);
} else if (strcmp(name, "useraction") == 0) {
RecordAction(value);
} else {
LOG(ERROR) << "invalid event type: " << name;
}
}
}
result = ftruncate(fd, 0);
if (result < 0) {
PLOG(ERROR) << "truncate metrics log";
}
result = flock(fd, LOCK_UN);
if (result < 0) {
PLOG(ERROR) << "unlock metrics log";
}
result = close(fd);
if (result < 0) {
PLOG(ERROR) << "close metrics log";
}
}
void ExternalMetrics::CollectEventsAndReschedule() {
PerfTimer timer;
CollectEvents();
UMA_HISTOGRAM_TIMES("UMA.CollectExternalEventsTime", timer.Elapsed());
ScheduleCollector();
}
void ExternalMetrics::ScheduleCollector() {
bool result;
result = ChromeThread::PostDelayedTask(
ChromeThread::FILE, FROM_HERE, NewRunnableMethod(
this, &chromeos::ExternalMetrics::CollectEventsAndReschedule),
kExternalMetricsCollectionIntervalMs);
DCHECK(result);
}
} // namespace chromeos
|
