| 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 # HistogramSet JSON Format | 6 # HistogramSet JSON Format |
| 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 111 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 122 specify which summary statistics are interesting and should be displayed. | 122 specify which summary statistics are interesting and should be displayed. |
| 123 | 123 |
| 124 DiagnosticMap is a dictionary mapping strings to Diagnostic dictionaries. | 124 DiagnosticMap is a dictionary mapping strings to Diagnostic dictionaries. |
| 125 | 125 |
| 126 ## Diagnostics | 126 ## Diagnostics |
| 127 | 127 |
| 128 The only field that is required for all Diagnostics, `type`, must be one of | 128 The only field that is required for all Diagnostics, `type`, must be one of |
| 129 * `GenericSet` | 129 * `GenericSet` |
| 130 * `RelatedEventSet` | 130 * `RelatedEventSet` |
| 131 * `Breakdown` | 131 * `Breakdown` |
| 132 * `RelatedHistogramSet` | |
| 133 * `RelatedHistogramMap` | 132 * `RelatedHistogramMap` |
| 134 * `RelatedHistogramBreakdown` | 133 * `RelatedHistogramBreakdown` |
| 135 * `TelemetryInfo` | 134 * `TelemetryInfo` |
| 136 * `BuildbotInfo` | 135 * `BuildbotInfo` |
| 137 * `Scalar` | 136 * `Scalar` |
| 138 | 137 |
| 139 If a Diagnostic is in the root array of the JSON, then it is shared, so it may b
e | 138 If a Diagnostic is in the root array of the JSON, then it is shared, so it may b
e |
| 140 referenced by multiple Histograms. Shared Diagnostics must contain a string | 139 referenced by multiple Histograms. Shared Diagnostics must contain a string |
| 141 field `guid` containing a UUID. | 140 field `guid` containing a UUID. |
| 142 | 141 |
| (...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 183 * `value`: a dictionary containing a string `unit` and a number `value` | 182 * `value`: a dictionary containing a string `unit` and a number `value` |
| 184 | 183 |
| 185 ### Breakdown | 184 ### Breakdown |
| 186 | 185 |
| 187 This allows metrics to explain the magnitude of a sample as composed of various | 186 This allows metrics to explain the magnitude of a sample as composed of various |
| 188 categories. | 187 categories. |
| 189 | 188 |
| 190 * `values`: required dictionary mapping from a string category name to number v
alues | 189 * `values`: required dictionary mapping from a string category name to number v
alues |
| 191 * `colorScheme`: optional string specifying how the bar chart should be colored | 190 * `colorScheme`: optional string specifying how the bar chart should be colored |
| 192 | 191 |
| 193 ### RelatedHistogramSet | |
| 194 | |
| 195 This allows metrics to annotate which Histograms are related to other | |
| 196 Histograms. | |
| 197 | |
| 198 * `guids`: list of guids of related Histograms | |
| 199 | |
| 200 ### RelatedHistogramMap | 192 ### RelatedHistogramMap |
| 201 | 193 |
| 202 This allows metrics to annotate which Histograms are related to other | 194 This allows metrics to annotate which Histograms are related to other |
| 203 Histograms, and annotate the nature of the relationship with a custom string | 195 Histograms, and annotate the nature of the relationship with a custom string |
| 204 name. | 196 name. |
| 205 | 197 |
| 206 * `values`: dictionary mapping from custom string name to the related | 198 * `values`: dictionary mapping from custom string name to the related |
| 207 Histogram's string guid | 199 Histogram's string guid |
| 208 | 200 |
| 209 ### RelatedHistogramBreakdown | 201 ### RelatedHistogramBreakdown |
| (...skipping 11 matching lines...) Expand all Loading... |
| 221 | 213 |
| 222 * `events`: array of dictionaries containing `stableId`, `title`, `start`, | 214 * `events`: array of dictionaries containing `stableId`, `title`, `start`, |
| 223 `duration` fields of Events | 215 `duration` fields of Events |
| 224 | 216 |
| 225 ### DateRange | 217 ### DateRange |
| 226 | 218 |
| 227 This is a Range of Dates. | 219 This is a Range of Dates. |
| 228 | 220 |
| 229 * `min`: Unix timestamp in ms | 221 * `min`: Unix timestamp in ms |
| 230 * `max`: optional Unix timestamp in ms | 222 * `max`: optional Unix timestamp in ms |
| OLD | NEW |