README - Issue 2715005: Recommend including "Chrome OS" in the histogram description.

Side by Side Diff: README

Issue 2715005: Recommend including "Chrome OS" in the histogram description. (Closed) Base URL: ssh://git@chromiumos-git/metrics.git

Patch Set: Created 10 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

« no previous file with comments | « no previous file | no next file » | no next file with comments »

OLD	NEW
1 Copyright (c) 2010 The Chromium OS Authors. All rights reserved.	1 Copyright (c) 2010 The Chromium OS 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 The Chrome OS "metrics" package contains utilities for client-side	5 The Chrome OS "metrics" package contains utilities for client-side

6 user metric collection. The collected data is sent to Chrome for	6 user metric collection. The collected data is sent to Chrome for

7 transport to the UMA server.	7 transport to the UMA server.

8	8

9	9

10 ================================================================================	10 ================================================================================

(...skipping 53 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
64	64

65 ================================================================================	65 ================================================================================

66 Server Side	66 Server Side

67 ================================================================================	67 ================================================================================

68	68

69 If the histogram data is visible in about:histograms, it will be sent	69 If the histogram data is visible in about:histograms, it will be sent

70 by an official Chrome build to UMA, assuming the user has opted into	70 by an official Chrome build to UMA, assuming the user has opted into

71 metrics collection. To make the histogram visible on	71 metrics collection. To make the histogram visible on

72 "chromedashboard", the histogram wiki needs to be updated (steps 2 and	72 "chromedashboard", the histogram wiki needs to be updated (steps 2 and

73 3 after following the "Details on how to add your own histograms" link	73 3 after following the "Details on how to add your own histograms" link

74 under the Histograms tab).	74 under the Histograms tab). Include the string "Chrome OS" in the

	75 histogram description so that it's easier to distinguish Chrome OS

	76 specific metrics from general Chrome histograms.

75	77

76 The UMA server logs and keeps the collected field data even if the	78 The UMA server logs and keeps the collected field data even if the

77 metric's name is not added to the histogram wiki. However, the	79 metric's name is not added to the histogram wiki. However, the

78 dashboard histogram for that metric will show field data as of the	80 dashboard histogram for that metric will show field data as of the

79 histogram wiki update date; it will not include data for older	81 histogram wiki update date; it will not include data for older

80 dates. If past data needs to be displayed, manual server-side	82 dates. If past data needs to be displayed, manual server-side

81 intervention is required. In other words, one should assume that field	83 intervention is required. In other words, one should assume that field

82 data collection starts only after the histogram wiki has been updated.	84 data collection starts only after the histogram wiki has been updated.

83	85

84	86

(...skipping 21 matching lines...) Expand all Loading...
106 screen saver states to determine if the user is actively using the	108 screen saver states to determine if the user is actively using the

107 device or not and generates the corresponding data. The metrics daemon	109 device or not and generates the corresponding data. The metrics daemon

108 uses libmetrics to send the data to Chrome.	110 uses libmetrics to send the data to Chrome.

109	111

110 The recommended way to generate metrics data from a module is to link	112 The recommended way to generate metrics data from a module is to link

111 and use libmetrics directly. However, the module could instead send	113 and use libmetrics directly. However, the module could instead send

112 signals to or communicate in some alternative way with the metrics	114 signals to or communicate in some alternative way with the metrics

113 daemon. Then the metrics daemon needs to monitor for the relevant	115 daemon. Then the metrics daemon needs to monitor for the relevant

114 events and take appropriate action -- for example, aggregate data and	116 events and take appropriate action -- for example, aggregate data and

115 send the histogram samples.	117 send the histogram samples.

OLD	NEW