OLD | NEW |
1 <!-- Copyright 2016 The Chromium Authors. All rights reserved. | 1 <!-- Copyright 2016 The Chromium 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 | 5 |
6 # Metrics Results UI | 6 # Metrics Results UI |
7 | 7 |
8 This document assumes familiarity with the concepts introduced in | 8 This document assumes familiarity with the concepts introduced in |
9 [how-to-write-metrics](/docs/how-to-write-metrics.md). | 9 [how-to-write-metrics](/docs/how-to-write-metrics.md). |
10 | 10 |
(...skipping 88 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
99 | 99 |
100 ### The Show Histogram Button | 100 ### The Show Histogram Button |
101 | 101 |
102 By default, table cells contain only averages of the Histograms in those cells. | 102 By default, table cells contain only averages of the Histograms in those cells. |
103 | 103 |
104 Click the bar chart icon in table cells to display more information about the | 104 Click the bar chart icon in table cells to display more information about the |
105 Histogram: | 105 Histogram: |
106 * Histogram bin count bar chart (if the Histogram has only a single bin, then | 106 * Histogram bin count bar chart (if the Histogram has only a single bin, then |
107 it will be a box chart), | 107 it will be a box chart), |
108 * summary statistics as configured by the metric, | 108 * summary statistics as configured by the metric, |
109 * Diagnostics | 109 * Up to 3 groups of diagnostics may be available in tabs: |
| 110 * Metadata |
| 111 * Sample diagnostics |
| 112 * Other diagnostics added to Histograms by metrics |
| 113 |
| 114 ![Diagnostics tabs |
| 115 ](/docs/images/metrics-results-ui-diagnostics-tabs.png) |
| 116 |
| 117 Metadata may contain |
| 118 * Information about the device that produced the results |
| 119 * Telemetry context |
| 120 * Source control revisions |
| 121 * Links to logs and traces |
| 122 These metadata diagnostics are added to Histograms by telemetry or other |
| 123 processes outside of metrics. |
| 124 |
| 125 Metrics can add diagnostics either to samples within Histograms or to Histograms |
| 126 themselves. |
110 | 127 |
111 Click and drag the mouse around the bar chart in order to display sample | 128 Click and drag the mouse around the bar chart in order to display sample |
112 diagnostics for the selected Histogram bins. | 129 diagnostics for the selected Histogram bins. |
113 | 130 |
114 ![Show full Histogram data for a cell. | 131 ![Show full Histogram data for a cell. |
115 ](/docs/images/metrics-results-ui-show-histogram.png) | 132 ](/docs/images/metrics-results-ui-show-histogram.png) |
116 | 133 |
| 134 Sample diagnostics may include Breakdown diagnostics, which indicate relative |
| 135 sizes of component metrics for the selected samples. |
| 136 |
| 137 ![Breakdowns](/docs/images/how-to-write-metrics-breakdown.png) |
| 138 |
| 139 Other Histogram diagnostics may include RelatedHistogramBreakdown diagnostics, |
| 140 which indicate relative sizes of component metrics over all samples. |
| 141 |
| 142 ![RelatedHistogramBreakdowns](/docs/images/how-to-write-metrics-related-histogra
m-breakdown.png) |
| 143 |
| 144 For more about summation metrics, see [Diagnostic |
| 145 Metrics](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/speed/diagno
stic_metrics.md#Summation-Diagnostics). |
| 146 |
117 ## The Groupby-picker | 147 ## The Groupby-picker |
118 | 148 |
119 The `groupby-picker` sits just above the table and allows you to control how | 149 The `groupby-picker` sits just above the table and allows you to control how |
120 Histograms are grouped into the Grouping Tree. | 150 Histograms are grouped into the Grouping Tree. |
121 | 151 |
122 Grouping keys include | 152 Grouping keys include |
123 * Histogram name | 153 * Histogram name |
124 * Benchmark name | 154 * Benchmark name |
125 * Story name | 155 * Story name |
126 * Storyset repetition | 156 * Storyset repetition |
(...skipping 180 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
307 | 337 |
308 ### The Show All Checkbox | 338 ### The Show All Checkbox |
309 | 339 |
310 By default, this checkbox is unchecked so that the table only displays | 340 By default, this checkbox is unchecked so that the table only displays |
311 Histograms that are source nodes in the metric graphical model. | 341 Histograms that are source nodes in the metric graphical model. |
312 Check this checkbox in order to show all Histograms, including those that are | 342 Check this checkbox in order to show all Histograms, including those that are |
313 not source nodes in the metric graphical model. | 343 not source nodes in the metric graphical model. |
314 | 344 |
315 ![Show All Histograms checkbox. | 345 ![Show All Histograms checkbox. |
316 ](/docs/images/metrics-results-ui-show-all.png) | 346 ](/docs/images/metrics-results-ui-show-all.png) |
OLD | NEW |