Skip to content

Commit

Permalink
Cherry pick PR #769: Document metrics setting persistence in IDL file…
Browse files Browse the repository at this point in the history
… (#819)

b/286898092

Change-Id: I84882161c51113859ceb11f8cdd2250aff666de7
(cherry picked from commit 0da3ca6)

Co-authored-by: Joel Martinez <joeltine@google.com>
  • Loading branch information
cobalt-github-releaser-bot and joeltine authored Jul 6, 2023
1 parent 1cf9dd6 commit 265e30c
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions cobalt/h5vcc/h5vcc_metrics.idl
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@ interface H5vccMetrics {
// Enable Cobalt metrics logging. Metrics are disabled by default and should
// be enabled as soon as possible. When enabled, at regular intervals, the
// bound onMetricEvent callback will be called with telemetry payloads to
// be uploaded and logged on the server.
// TODO(b/286898092): Update docs here when setting is persistent.
// be uploaded and logged on the server. Both the enable/disable settings
// are persistent or "sticky". That is, you only have to call them once
// and that setting will persist through multiple app lifecycles until the
// enable/disable APIs are explicitly called again.
void enable();

// Disable Cobalt metrics logging. If disabled, the metric event handler
Expand All @@ -52,7 +54,9 @@ interface H5vccMetrics {

// Sets the frequency in which Cobalt metrics will be snapshotted and sent to
// the metric event handler. Defaults to 5 minutes if not set. Must be > 0,
// else will be ignored.
// else will be ignored. This setting is persistent. That is, it's "sticky"
// and will be persisted through multiple app lifetimes unless it's called
// again with a different value.
void setMetricEventInterval(unsigned long intervalSeconds);
};

Expand Down

0 comments on commit 265e30c

Please sign in to comment.