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
|
// Copyright (c) 2006-2008 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 CHROME_BROWSER_METRICS_USER_METRICS_H_
#define CHROME_BROWSER_METRICS_USER_METRICS_H_
#include <string>
class Profile;
// This module provides some helper functions for logging actions tracked by
// the user metrics system.
// UserMetricsAction exist purely to standardize on the paramters passed to
// UserMetrics. That way, our toolset can scan the sourcecode reliable for
// constructors and extract the associated string constants
struct UserMetricsAction {
const char* str_;
explicit UserMetricsAction(const char* str) : str_(str) {}
};
class UserMetrics {
public:
// Record that the user performed an action.
// "Action" here means a user-generated event:
// good: "Reload", "CloseTab", and "IMEInvoked"
// not good: "SSLDialogShown", "PageLoaded", "DiskFull"
// We use this to gather anonymized information about how users are
// interacting with the browser.
// WARNING: Call this function exactly like this, with the string literal
// inline:
// UserMetrics::RecordAction("foo bar", profile);
// because otherwise our processing scripts won't pick up on new actions.
//
// For more complicated situations (like when there are many different
// possible actions), see RecordComputedAction.
//
// TODO(semenzato): |profile| isn't actually used---should switch all calls
// to the version without it.
static void RecordAction(const UserMetricsAction& action, Profile* profile);
// This function has identical input and behavior to RecordAction, but is
// not automatically found by the action-processing scripts. It can be used
// when it's a pain to enumerate all possible actions, but if you use this
// you need to also update the rules for extracting known actions.
static void RecordComputedAction(const std::string& action,
Profile* profile);
static void RecordAction(const UserMetricsAction& action);
static void RecordComputedAction(const std::string& action);
private:
static void Record(const char *action, Profile *profile);
static void Record(const char *action);
};
#endif // CHROME_BROWSER_METRICS_USER_METRICS_H_
|