| OLD | NEW |
| 1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef BASE_METRICS_USER_METRICS_H_ | 5 #ifndef BASE_METRICS_USER_METRICS_H_ |
| 6 #define BASE_METRICS_USER_METRICS_H_ | 6 #define BASE_METRICS_USER_METRICS_H_ |
| 7 | 7 |
| 8 #include <string> | 8 #include <string> |
| 9 | 9 |
| 10 #include "base/base_export.h" | 10 #include "base/base_export.h" |
| 11 #include "base/callback.h" | 11 #include "base/callback.h" |
| 12 #include "base/metrics/user_metrics_action.h" | 12 #include "base/metrics/user_metrics_action.h" |
| 13 #include "base/single_thread_task_runner.h" | 13 #include "base/single_thread_task_runner.h" |
| 14 | 14 |
| 15 namespace base { | 15 namespace base { |
| 16 | 16 |
| 17 // This module provides some helper functions for logging actions tracked by | 17 // This module provides some helper functions for logging actions tracked by |
| 18 // the user metrics system. | 18 // the user metrics system. |
| 19 | 19 |
| 20 // Record that the user performed an action. | 20 // Record that the user performed an action. |
| 21 // This function must be called after the task runner has been set with | 21 // This function must be called after the task runner has been set with |
| 22 // SetRecordActionTaskRunner(). | 22 // SetRecordActionTaskRunner(). |
| 23 // | 23 // |
| 24 // "Action" here means a user-generated event: | 24 // "Action" here means a user-generated event: |
| 25 // good: "Reload", "CloseTab", and "IMEInvoked" | 25 // good: "Reload", "CloseTab", and "IMEInvoked" |
| 26 // not good: "SSLDialogShown", "PageLoaded", "DiskFull" | 26 // not good: "SSLDialogShown", "PageLoaded", "DiskFull" |
| 27 // We use this to gather anonymized information about how users are | 27 // We use this to gather anonymized information about how users are |
| 28 // interacting with the browser. | 28 // interacting with the browser. |
| 29 // WARNING: In calls to this function, UserMetricsAction and a | 29 // WARNING: In calls to this function, UserMetricsAction should be followed by a |
| 30 // string literal parameter must be on the same line, e.g. | 30 // string literal parameter and not a variable e.g. |
| 31 // RecordAction(UserMetricsAction("my extremely long action name")); | 31 // RecordAction(UserMetricsAction("my action name")); |
| 32 // This ensures that our processing scripts can associate this action's hash | 32 // This ensures that our processing scripts can associate this action's hash |
| 33 // with its metric name. Therefore, it will be possible to retrieve the metric | 33 // with its metric name. Therefore, it will be possible to retrieve the metric |
| 34 // name from the hash later on. | 34 // name from the hash later on. |
| 35 // | 35 // |
| 36 // Once a new recorded action is added, run | 36 // Once a new recorded action is added, run |
| 37 // tools/metrics/actions/extract_actions.py | 37 // tools/metrics/actions/extract_actions.py |
| 38 // to add the metric to actions.xml, then update the <owner>s and <description> | 38 // to add the metric to actions.xml, then update the <owner>s and <description> |
| 39 // sections. Make sure to include the actions.xml file when you upload your code | 39 // sections. Make sure to include the actions.xml file when you upload your code |
| 40 // for review! | 40 // for review! |
| 41 // | 41 // |
| (...skipping 19 matching lines...) Expand all Loading... |
| 61 BASE_EXPORT void AddActionCallback(const ActionCallback& callback); | 61 BASE_EXPORT void AddActionCallback(const ActionCallback& callback); |
| 62 BASE_EXPORT void RemoveActionCallback(const ActionCallback& callback); | 62 BASE_EXPORT void RemoveActionCallback(const ActionCallback& callback); |
| 63 | 63 |
| 64 // Set the task runner on which to record actions. | 64 // Set the task runner on which to record actions. |
| 65 BASE_EXPORT void SetRecordActionTaskRunner( | 65 BASE_EXPORT void SetRecordActionTaskRunner( |
| 66 scoped_refptr<SingleThreadTaskRunner> task_runner); | 66 scoped_refptr<SingleThreadTaskRunner> task_runner); |
| 67 | 67 |
| 68 } // namespace base | 68 } // namespace base |
| 69 | 69 |
| 70 #endif // BASE_METRICS_USER_METRICS_H_ | 70 #endif // BASE_METRICS_USER_METRICS_H_ |
| OLD | NEW |