commit 58b61eedb414aee607c53b6e36e33d432c78a38d
author Laura Peskin <pesk@google.com> Tue Mar 16 22:02:35 2021 +0000
committer CQ Bot <commit-bot@chromium.org> Tue Mar 16 22:02:35 2021 +0000
tree 185d74966349b993e4ad0e1c4c90169fb6693f03
parent 122d3ed0f7582cb4cf5563efb51f2d0badb5616e

[Cobalt 1.1 privacy] Update ReportDefinition comments

Corrects the comments on the `min_value`, `max_value`, and
`max_count` fields of ReportDefinition to match the current
requirements.

Bug: 70382
Change-Id: Ic93904f9f230e59a6301bcc1c6bae3a428d6f1e0
Reviewed-on: https://fuchsia-review.googlesource.com/c/cobalt/+/502428
Commit-Queue: Laura Peskin <pesk@google.com>
Reviewed-by: Cameron Dale <camrdale@google.com>

src/registry/report_definition.proto

diff --git a/src/registry/report_definition.proto b/src/registry/report_definition.proto
index 7ba7c38..2f6838e 100644
--- a/src/registry/report_definition.proto
+++ b/src/registry/report_definition.proto
@@ -611,23 +611,19 @@
   // in the specified local_aggregation_period. If the true value to be reported
   // falls outside specified range, the value is clipped.
   //
-  // For UNIQUE_DEVICE_NUMERIC_STATS and HOURLY_VALUE_NUMERIC_STATS, the range
-  // applies to the numerical value computed for the device.
-  //
-  // For UNIQUE_DEVICE_HISTOGRAMS, HOURLY_VALUE_HISTOGRAMS and
-  // FLEETWIDE_HISTOGRAMS, the range applies to the values contained in the
-  // individual buckets for each histogram.
+  // For FLEETWIDE_OCCURRENCE_COUNTS, UNIQUE_DEVICE_NUMERIC_STATS and
+  // HOURLY_VALUE_NUMERIC_STATS, the range applies to the total numerical value
+  // computed for the device over the aggregation period specified in the report.
   //
   // For FLEETWIDE_MEANS, the range applies to the per-device sum of the value
-  // to be averaged.
+  // to be averaged over one hour. (For FLEETWIDE_MEANS, the `max_count` field is
+  // also required in order to bound the `count` value.)
   //
   // If a privacy_level other than NO_ADDED_PRIVACY is specified, this field is
   // required for reports of type:
+  // * FLEETWIDE_OCCURRENCE_COUNTS
   // * UNIQUE_DEVICE_NUMERIC_STATS
   // * HOURLY_VALUE_NUMERIC_STATS
-  // * UNIQUE_DEVICE_HISTOGRAMS
-  // * HOURLY_VALUE_HISTOGRAMS
-  // * FLEETWIDE_HISTOGRAMS
   // * FLEETWIDE_MEANS
   int64 min_value = 23;
   int64 max_value = 24;
@@ -636,9 +632,16 @@
   // specified local_aggregation_period. If the true count is greater than
   // max_count, then the count will be reported as max_count.
   //
+  // For FLEETWIDE_HISTOGRAMS, the bound applies to the count for each
+  // individual histogram bucket over the aggregation period of one hour. For
+  // STRING_COUNTS, it applies to the count for each string over one hour.
+  //
+  // For FLEETWIDE_MEANS, the bound applies to the per-device count of the
+  // values to be averaged over one hour.
+  //
   // If a privacy_level other than NO_ADDED_PRIVACY is specified, this field is
   // required for reports of type:
-  // * FLEETWIDE_OCCURRENCE_COUNTS
+  // * FLEETWIDE_HISTOGRAMS
   // * FLEETWIDE_MEANS
   // * STRING_COUNTS
   uint64 max_count = 25;