File: metrics_handler.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (66 lines) | stat: -rw-r--r-- 2,833 bytes parent folder | download | duplicates (8)
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
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_WEBUI_METRICS_HANDLER_H_
#define CHROME_BROWSER_UI_WEBUI_METRICS_HANDLER_H_

#include "content/public/browser/web_ui_message_handler.h"

///////////////////////////////////////////////////////////////////////////////
// MetricsHandler

// Let the page contents record UMA actions. Only use when you can't do it from
// C++. For example, we currently use it to let the NTP log the position of the
// Most Visited or Bookmark the user clicked on, as we don't get that
// information through RequestOpenURL. You will need to update the metrics
// dashboard with the action names you use, as our processor won't catch that
// information (treat it as RecordComputedMetrics)

class MetricsHandler : public content::WebUIMessageHandler {
 public:
  MetricsHandler();

  MetricsHandler(const MetricsHandler&) = delete;
  MetricsHandler& operator=(const MetricsHandler&) = delete;

  ~MetricsHandler() override;

  // WebUIMessageHandler implementation.
  void RegisterMessages() override;

  // Callback for the "metricsHandler:recordAction" message. This records a
  // user action.
  void HandleRecordAction(const base::Value::List& args);

  // TODO(dbeam): http://crbug.com/104338

  // Callback for the "metricsHandler:recordInHistogram" message. This records
  // into a histogram. |args| contains the histogram name, the value to record,
  // and the maximum allowed value, which can be at most 4000. The histogram
  // will use at most 100 buckets, one for each 1, 10, or 100 different values,
  // depending on the maximum value.
  void HandleRecordInHistogram(const base::Value::List& args);

  // Callback for the "metricsHandler:recordBooleanHistogram" message. This
  // records into a boolean histogram. |args| contains the histogram name, and
  // the value to record.
  void HandleRecordBooleanHistogram(const base::Value::List& args);

  // Records a millisecond time value in a histogram, similar to
  // UMA_HISTOGRAM_TIMES. Handles times between 1ms and 10sec. |args|
  // contains the histogram name and a value in milliseconds.
  void HandleRecordTime(const base::Value::List& args);

  // Records a millisecond time value in a histogram, similar to
  // UmaHistogramMedium. Handles times up to 3 minutes. |args| contains the
  // histogram name and a value in milliseconds.
  void HandleRecordMediumTime(const base::Value::List& args);

  // Callback for the "metricsHandler:recordSparseHistogram" message. This
  // records into a sparse histogram. |args| contains the histogram name and
  // the sample value to record.
  void HandleRecordSparseHistogram(const base::Value::List& args);
};

#endif  // CHROME_BROWSER_UI_WEBUI_METRICS_HANDLER_H_