Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(831)

Unified Diff: docs/metrics-results-ui.md

Issue 2997223002: Add screenshots of diagnostics to metrics-results-ui.md. (Closed)
Patch Set: Created 3 years, 4 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « docs/images/metrics-results-ui-diagnostics-tabs.png ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/metrics-results-ui.md
diff --git a/docs/metrics-results-ui.md b/docs/metrics-results-ui.md
index 80c472fdcdcafe67ee94c7af30b32338e926535b..8c5a44a7b1153a4e6798660bc8253a7fe058cee0 100644
--- a/docs/metrics-results-ui.md
+++ b/docs/metrics-results-ui.md
@@ -106,7 +106,24 @@ Histogram:
* Histogram bin count bar chart (if the Histogram has only a single bin, then
it will be a box chart),
* summary statistics as configured by the metric,
- * Diagnostics
+ * Up to 3 groups of diagnostics may be available in tabs:
+ * Metadata
+ * Sample diagnostics
+ * Other diagnostics added to Histograms by metrics
+
+![Diagnostics tabs
+](/docs/images/metrics-results-ui-diagnostics-tabs.png)
+
+Metadata may contain
+ * Information about the device that produced the results
+ * Telemetry context
+ * Source control revisions
+ * Links to logs and traces
+These metadata diagnostics are added to Histograms by telemetry or other
+processes outside of metrics.
+
+Metrics can add diagnostics either to samples within Histograms or to Histograms
+themselves.
Click and drag the mouse around the bar chart in order to display sample
diagnostics for the selected Histogram bins.
@@ -114,6 +131,19 @@ diagnostics for the selected Histogram bins.
![Show full Histogram data for a cell.
](/docs/images/metrics-results-ui-show-histogram.png)
+Sample diagnostics may include Breakdown diagnostics, which indicate relative
+sizes of component metrics for the selected samples.
+
+![Breakdowns](/docs/images/how-to-write-metrics-breakdown.png)
+
+Other Histogram diagnostics may include RelatedHistogramBreakdown diagnostics,
+which indicate relative sizes of component metrics over all samples.
+
+![RelatedHistogramBreakdowns](/docs/images/how-to-write-metrics-related-histogram-breakdown.png)
+
+For more about summation metrics, see [Diagnostic
+Metrics](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/speed/diagnostic_metrics.md#Summation-Diagnostics).
+
## The Groupby-picker
The `groupby-picker` sits just above the table and allows you to control how
« no previous file with comments | « docs/images/metrics-results-ui-diagnostics-tabs.png ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698