summaryrefslogtreecommitdiffstats
path: root/chromium/third_party/catapult/tracing/tracing/metrics/uma_metric_test.html
blob: ae512c6b4efb13d37055f9ca1ae398559b622d23 (plain)
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<!DOCTYPE html>
<!--
Copyright 2019 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.
-->

<link rel="import" href="/tracing/base/utils.html">
<link rel="import" href="/tracing/core/test_utils.html">
<link rel="import" href="/tracing/metrics/uma_metric.html">
<link rel="import" href="/tracing/value/histogram_set.html">

<script>
'use strict';

tr.b.unittest.testSuite(function() {
  // 1 sample in [1, 3) and 2 samples in [3, 7).
  const BROWSER_BUCKETS1 =
      'LAAAAAwAAAAAAAAAAwAAAAEAAAADAAAAAAAAAAEAAAADAAAABwAAAAAAAAACAAAA';
  // 1 sample in [3, 7).
  const BROWSER_BUCKETS2 = 'HAAAAAUAAAAAAAAAAQAAAAMAAAAHAAAAAAAAAAEAAAA=';
  // 2 samples in [7, 9).
  const RENDERER_BUCKETS = 'HAAAABAAAAAAAAAAAgAAAAcAAAAJAAAAAAAAAAIAAAA=';
  // 1 sample in [8, 10).
  const RENDERER_INCOMPATIBLE_BUCKETS =
      'HAAAAAkAAAAAAAAAAQAAAAgAAAAKAAAAAAAAAAEAAAA=';
  // 1 sample in [1, 3) and 2 samples in [3, 7). The sum is 9.
  const SHIFTED_SAMPLES =
      'LAAAAAkAAAAAAAAAAwAAAAEAAAADAAAAAAAAAAEAAAADAAAABwAAAAAAAAACAAAA';
  // 50 samples in [2^30, 2^30 + 2).
  const LARGE_SUM = 'HAAAADIAAIAMAAAAMgAAAAAAAEACAABAAAAAADIAAAA=';

  test('simpleUMA', function() {
    const model = tr.c.TestUtils.newModel((model) => {
      const browserProcess = model.getOrCreateProcess(0);
      browserProcess.getOrCreateThread(0).name = 'CrBrowserMain';
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 2,
        args: {
          name: 'metric1',
          buckets: BROWSER_BUCKETS1}}));
    });
    const histograms = new tr.v.HistogramSet();
    tr.metrics.umaMetric(histograms, model);
    const hist = histograms.getHistogramNamed('metric1');

    // The histogram looks like:
    //         *
    //   *     *
    // 1 2 3 4 5 6 7
    assert.closeTo(2, hist.min, 1e-6);
    assert.closeTo(5, hist.max, 1e-6);
    assert.closeTo(4, hist.average, 1e-6);

    const bin = hist.getBinForValue(2);
    const processes = tr.b.getOnlyElement(bin.diagnosticMaps).get('processes');
    assert.closeTo(2, processes.get('browser_process_1'), 1e-6);
  });

  test('twoUMASnapshots', function() {
    const model = tr.c.TestUtils.newModel((model) => {
      const browserProcess = model.getOrCreateProcess(0);
      browserProcess.getOrCreateThread(0).name = 'CrBrowserMain';
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 1,
        args: {
          name: 'metric1',
          buckets: BROWSER_BUCKETS2}}));
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 2,
        args: {
          name: 'metric1',
          buckets: BROWSER_BUCKETS1}}));
    });
    const histograms = new tr.v.HistogramSet();
    tr.metrics.umaMetric(histograms, model);
    const hist = histograms.getHistogramNamed('metric1');

    // (BROWSER_BUCKETS1 - BROWSER_BUCKETS2) looks like
    //   *     *
    // 1 2 3 4 5 6 7
    assert.closeTo(2, hist.min, 1e-6);
    assert.closeTo(5, hist.max, 1e-6);
    assert.closeTo(3.5, hist.average, 1e-6);
  });

  test('twoUMASnapshotsInDifferentProcesses', function() {
    const model = tr.c.TestUtils.newModel((model) => {
      const browserProcess = model.getOrCreateProcess(0);
      browserProcess.getOrCreateThread(0).name = 'CrBrowserMain';
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 1,
        args: {
          name: 'metric1',
          buckets: BROWSER_BUCKETS2}}));
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 2,
        args: {
          name: 'metric1',
          buckets: BROWSER_BUCKETS1}}));
      const process = model.getOrCreateProcess(1);
      process.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 2,
        args: {
          name: 'metric1',
          buckets: RENDERER_BUCKETS}}));
    });
    const histograms = new tr.v.HistogramSet();
    tr.metrics.umaMetric(histograms, model);
    const hist = histograms.getHistogramNamed('metric1');

    // The aggregated histogram looks like
    //               *
    //   *     *     *
    // 1 2 3 4 5 6 7 8 9
    assert.closeTo(2, hist.min, 1e-6);
    assert.closeTo(8, hist.max, 1e-6);
    assert.closeTo(5.75, hist.average, 1e-6);

    const bin = hist.getBinForValue(8);
    for (const diagnostics of bin.diagnosticMaps) {
      assert.closeTo(
          8, diagnostics.get('processes').get('unknown_processes_1'), 1e-6);
    }
  });

  test('samplesNotInTheMiddle', function() {
    const model = tr.c.TestUtils.newModel((model) => {
      const browserProcess = model.getOrCreateProcess(0);
      browserProcess.getOrCreateThread(0).name = 'CrBrowserMain';
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 2,
        args: {
          name: 'metric1',
          buckets: SHIFTED_SAMPLES}}));
    });
    const histograms = new tr.v.HistogramSet();
    tr.metrics.umaMetric(histograms, model);
    const hist = histograms.getHistogramNamed('metric1');

    // There is 1 sample in [1, 3) and 2 samples in [3, 7). Since the sum is 9,
    // we put samples lower than the middle of the bins so that they sum to 9.
    assert.closeTo(1.4, hist.min, 1e-6);
    assert.closeTo(3.8, hist.max, 1e-6);
    assert.closeTo(3, hist.average, 1e-6);
  });

  test('largeSampleSum', function() {
    const model = tr.c.TestUtils.newModel((model) => {
      const browserProcess = model.getOrCreateProcess(0);
      browserProcess.getOrCreateThread(0).name = 'CrBrowserMain';
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 2,
        args: {
          name: 'metric1',
          buckets: LARGE_SUM}}));
    });
    const histograms = new tr.v.HistogramSet();
    tr.metrics.umaMetric(histograms, model);
    const hist = histograms.getHistogramNamed('metric1');

    assert.closeTo((1 << 30) + 1, hist.min, 1e-6);
    assert.closeTo((1 << 30) + 1, hist.max, 1e-6);
    assert.closeTo(((1 << 30) + 1) * 50, hist.sum, 1e-6);
  });

  test('incompatibleUMASnapshots', function() {
    const model = tr.c.TestUtils.newModel((model) => {
      model.getOrCreateProcess(0).getOrCreateThread(0).name = 'CrBrowserMain';
      model.getOrCreateProcess(1).instantEvents.push(
          tr.c.TestUtils.newInstantEvent({
            title: 'UMAHistogramSamples', start: 2,
            args: {
              name: 'metric1',
              buckets: RENDERER_BUCKETS}})
      );
      model.getOrCreateProcess(2).instantEvents.push(
          tr.c.TestUtils.newInstantEvent({
            title: 'UMAHistogramSamples', start: 2,
            args: {
              name: 'metric1',
              buckets: RENDERER_INCOMPATIBLE_BUCKETS}})
      );
    });
    const histograms = new tr.v.HistogramSet();

    assert.throws(function() {
      tr.metrics.umaMetric(histograms, model);
    }, 'Incompatible bins');
  });

  test('badStartStopUMASnapshots', function() {
    const model = tr.c.TestUtils.newModel((model) => {
      const browserProcess = model.getOrCreateProcess(0);
      browserProcess.getOrCreateThread(0).name = 'CrBrowserMain';
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 1,
        args: {
          name: 'metric1',
          buckets: BROWSER_BUCKETS1}}));
      browserProcess.instantEvents.push(tr.c.TestUtils.newInstantEvent({
        title: 'UMAHistogramSamples', start: 2,
        args: {
          name: 'metric1',
          buckets: BROWSER_BUCKETS2}}));
    });
    const histograms = new tr.v.HistogramSet();

    assert.throws(function() {
      tr.metrics.umaMetric(histograms, model);
    }, 'Cannot subtract');
  });
});
</script>