Commit fa0a3faf authored by Brian White's avatar Brian White Committed by Commit Bot

Improved description of the operation of "expires_after" for histograms.

b/131237867

Change-Id: Iaeb41b0256ae366243f2ab0ab653ef6bb6566bad
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1585939
Auto-Submit: Brian White <bcwhite@chromium.org>
Commit-Queue: Alexei Svitkine <asvitkine@chromium.org>
Reviewed-by: default avatarAlexei Svitkine <asvitkine@chromium.org>
Cr-Commit-Position: refs/heads/master@{#659071}
parent c715358a
...@@ -314,13 +314,21 @@ contact someone from the OWNERS file. ...@@ -314,13 +314,21 @@ contact someone from the OWNERS file.
Histogram expiry is specified by **'expires_after'** attribute in histogram Histogram expiry is specified by **'expires_after'** attribute in histogram
descriptions in histograms.xml. The attribute can be specified as date in descriptions in histograms.xml. The attribute can be specified as date in
**YYYY-MM-DD** format or as Chrome milestone in **M**\*(e.g. M68) format. After **YYYY-MM-DD** format or as Chrome milestone in **M**\*(e.g. M68) format. In the
a histogram expires, it will not be recorded (nor uploaded to the UMA servers). latter case, the actual expiry date is about 12 weeks after that branch is cut,
The code to record it becomes dead code, and should be removed from the or basically when it is replaced on the "stable" channel by the following
codebase along with marking the histogram definition as obsolete. However, if release.
histogram would remain useful, the expiration should be extended accordingly
before it becomes expired. If histogram you care about already expired, see After a histogram expires, it will cease to be displayed on the dashboard.
[Expired Histogram Whitelist](#Expired-histogram-whitelist). However, the client may continue to send data for that histogram for some time
after the official expiry date so simply bumping the 'expires_after' date in
HEAD may be sufficient to resurrect it without any discontinuity. If too much
time has passed and the client is no longer sending data, it can be re-enabled
via Finch: see [Expired Histogram Whitelist](#Expired-histogram-whitelist).
Once a histogram has expired, the code to record it becomes dead code and should
be removed from the codebase along with marking the histogram definition as
obsolete.
In **rare** cases, the expiry can be set to "never". This is used to denote In **rare** cases, the expiry can be set to "never". This is used to denote
metrics of critical importance that are, typically, used for other reports. metrics of critical importance that are, typically, used for other reports.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment