summaryrefslogtreecommitdiffstats
path: root/chrome/browser/user_metrics.h
diff options
context:
space:
mode:
authorinitial.commit <initial.commit@0039d316-1c4b-4281-b951-d872f2087c98>2008-07-26 23:55:29 +0000
committerinitial.commit <initial.commit@0039d316-1c4b-4281-b951-d872f2087c98>2008-07-26 23:55:29 +0000
commit09911bf300f1a419907a9412154760efd0b7abc3 (patch)
treef131325fb4e2ad12c6d3504ab75b16dd92facfed /chrome/browser/user_metrics.h
parent586acc5fe142f498261f52c66862fa417c3d52d2 (diff)
downloadchromium_src-09911bf300f1a419907a9412154760efd0b7abc3.zip
chromium_src-09911bf300f1a419907a9412154760efd0b7abc3.tar.gz
chromium_src-09911bf300f1a419907a9412154760efd0b7abc3.tar.bz2
Add chrome to the repository.
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@15 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/browser/user_metrics.h')
-rw-r--r--chrome/browser/user_metrics.h63
1 files changed, 63 insertions, 0 deletions
diff --git a/chrome/browser/user_metrics.h b/chrome/browser/user_metrics.h
new file mode 100644
index 0000000..3411022
--- /dev/null
+++ b/chrome/browser/user_metrics.h
@@ -0,0 +1,63 @@
+// Copyright 2008, Google Inc.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+// * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#ifndef CHROME_BROWSER_USER_METRICS_H__
+#define CHROME_BROWSER_USER_METRICS_H__
+
+#include <string>
+
+// This module provides some helper functions for logging actions tracked by
+// the user metrics system.
+
+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(L"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.
+ static void RecordAction(const wchar_t* 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::wstring& action,
+ Profile* profile);
+};
+
+#endif // CHROME_BROWSER_USER_METRICS_H__