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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
// Copyright 2014 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.
package org.chromium.base.metrics;
import org.chromium.base.JNINamespace;
import org.chromium.base.VisibleForTesting;
import java.util.concurrent.TimeUnit;
/**
* Java API for recording UMA histograms. Internally, the histogram will be cached by
* System.identityHashCode(name).
*
* Note: the JNI calls are relatively costly - avoid calling these methods in performance-critical
* code.
*/
@JNINamespace("base::android")
public class RecordHistogram {
/**
* Records a sample in a boolean UMA histogram of the given name. Boolean histogram has two
* buckets, corresponding to success (true) and failure (false). This is the Java equivalent of
* the UMA_HISTOGRAM_BOOLEAN C++ macro.
* @param name name of the histogram
* @param sample sample to be recorded, either true or false
*/
public static void recordBooleanHistogram(String name, boolean sample) {
nativeRecordBooleanHistogram(name, System.identityHashCode(name), sample);
}
/**
* Records a sample in an enumerated histogram of the given name and boundary. Note that
* |boundary| identifies the histogram - it should be the same at every invocation. This is the
* Java equivalent of the UMA_HISTOGRAM_ENUMERATION C++ macro.
* @param name name of the histogram
* @param sample sample to be recorded, at least 0 and at most |boundary| - 1
* @param boundary upper bound for legal sample values - all sample values have to be strictly
* lower than |boundary|
*/
public static void recordEnumeratedHistogram(String name, int sample, int boundary) {
nativeRecordEnumeratedHistogram(name, System.identityHashCode(name), sample, boundary);
}
/**
* Records a sample in a count histogram. This is the Java equivalent of the
* UMA_HISTOGRAM_COUNTS C++ macro.
* @param name name of the histogram
* @param sample sample to be recorded, at least 1 and at most 999999
*/
public static void recordCountHistogram(String name, int sample) {
recordCustomCountHistogram(name, sample, 1, 1000000, 50);
}
/**
* Records a sample in a count histogram. This is the Java equivalent of the
* UMA_HISTOGRAM_COUNTS_100 C++ macro.
* @param name name of the histogram
* @param sample sample to be recorded, at least 1 and at most 99
*/
public static void recordCount100Histogram(String name, int sample) {
recordCustomCountHistogram(name, sample, 1, 100, 50);
}
/**
* Records a sample in a count histogram. This is the Java equivalent of the
* UMA_HISTOGRAM_CUSTOM_COUNTS C++ macro.
* @param name name of the histogram
* @param sample sample to be recorded, at least |min| and at most |max| - 1
* @param min lower bound for expected sample values
* @param max upper bounds for expected sample values
* @param numBuckets the number of buckets
*/
public static void recordCustomCountHistogram(
String name, int sample, int min, int max, int numBuckets) {
nativeRecordCustomCountHistogram(
name, System.identityHashCode(name), sample, min, max, numBuckets);
}
/**
* Records a sparse histogram. This is the Java equivalent of UMA_HISTOGRAM_SPARSE_SLOWLY.
* @param name name of the histogram
* @param sample sample to be recorded. All values of |sample| are valid, including negative
* values.
*/
public static void recordSparseSlowlyHistogram(String name, int sample) {
nativeRecordSparseHistogram(name, System.identityHashCode(name), sample);
}
/**
* Records a sample in a histogram of times. Useful for recording short durations. This is the
* Java equivalent of the UMA_HISTOGRAM_TIMES C++ macro.
* @param name name of the histogram
* @param duration duration to be recorded
* @param timeUnit the unit of the duration argument
*/
public static void recordTimesHistogram(String name, long duration, TimeUnit timeUnit) {
recordCustomTimesHistogramMilliseconds(
name, timeUnit.toMillis(duration), 1, TimeUnit.SECONDS.toMillis(10), 50);
}
/**
* Records a sample in a histogram of times. Useful for recording medium durations. This is the
* Java equivalent of the UMA_HISTOGRAM_MEDIUM_TIMES C++ macro.
* @param name name of the histogram
* @param duration duration to be recorded
* @param timeUnit the unit of the duration argument
*/
public static void recordMediumTimesHistogram(String name, long duration, TimeUnit timeUnit) {
recordCustomTimesHistogramMilliseconds(
name, timeUnit.toMillis(duration), 10, TimeUnit.MINUTES.toMillis(3), 50);
}
/**
* Records a sample in a histogram of times. Useful for recording long durations. This is the
* Java equivalent of the UMA_HISTOGRAM_LONG_TIMES C++ macro.
* @param name name of the histogram
* @param duration duration to be recorded
* @param timeUnit the unit of the duration argument
*/
public static void recordLongTimesHistogram(String name, long duration, TimeUnit timeUnit) {
recordCustomTimesHistogramMilliseconds(
name, timeUnit.toMillis(duration), 1, TimeUnit.HOURS.toMillis(1), 50);
}
/**
* Records a sample in a histogram of times with custom buckets. This is the Java equivalent of
* the UMA_HISTOGRAM_CUSTOM_TIMES C++ macro.
* @param name name of the histogram
* @param duration duration to be recorded
* @param min the minimum bucket value
* @param max the maximum bucket value
* @param timeUnit the unit of the duration, min, and max arguments
* @param numBuckets the number of buckets
*/
public static void recordCustomTimesHistogram(
String name, long duration, long min, long max, TimeUnit timeUnit, int numBuckets) {
recordCustomTimesHistogramMilliseconds(name, timeUnit.toMillis(duration),
timeUnit.toMillis(min), timeUnit.toMillis(max), numBuckets);
}
private static void recordCustomTimesHistogramMilliseconds(
String name, long duration, long min, long max, int numBuckets) {
nativeRecordCustomTimesHistogramMilliseconds(
name, System.identityHashCode(name), duration, min, max, numBuckets);
}
/**
* Returns the number of samples recorded in the given bucket of the given histogram.
* @param name name of the histogram to look up
* @param sample the bucket containing this sample value will be looked up
*/
@VisibleForTesting
public static int getHistogramValueCountForTesting(String name, int sample) {
return nativeGetHistogramValueCountForTesting(name, sample);
}
/**
* Initializes the metrics system.
*/
public static void initialize() {
nativeInitialize();
}
private static native void nativeRecordCustomTimesHistogramMilliseconds(
String name, int key, long duration, long min, long max, int numBuckets);
private static native void nativeRecordBooleanHistogram(String name, int key, boolean sample);
private static native void nativeRecordEnumeratedHistogram(
String name, int key, int sample, int boundary);
private static native void nativeRecordCustomCountHistogram(
String name, int key, int sample, int min, int max, int numBuckets);
private static native void nativeRecordSparseHistogram(String name, int key, int sample);
private static native int nativeGetHistogramValueCountForTesting(String name, int sample);
private static native void nativeInitialize();
}
|
