Closed Bug 1434004 Opened 2 years ago Closed 2 years ago

Update documentation of C++ Telemetry probes

Categories

(Toolkit :: Telemetry, enhancement)

enhancement
Not set
normal

Tracking

()

RESOLVED INVALID

People

(Reporter: adbugger, Unassigned)

References

()

Details

The following bugs have extended the Telemetry::Accumulate() API to support adding multiple samples to various histogram types in one call from C++ :
 - bug 1428888
 - bug 1428885
 - bug 1364043

The following is in progress. This extends the same support for keyed categorical histograms:
 - bug 1433998

This is the last planned C++ extension (as of now) and the JSAPI will be updated after that, to allow the same functionality. Bug 1428893 tracks the JS changes.

According to :chutten from #telemetry, we should start advertising that these APIs exist so that callers can update their code. This bug is to update the documentation at https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html#adding-a-c-probe.

(The JSAPI section will probably have to updated later as well)
Needinfoing :chutten on this. This URL just mentions that Telemetry probes exist in Telemetry.h. This is not an exhaustive list and might not be the correct place to update the documentation. :chutten will know better.
Flags: needinfo?(chutten)
Neither nsITelemetry docs nor firefox-source-docs on Histograms contain exhaustive API documentation. So I guess this bug is already fixed.
Status: NEW → RESOLVED
Closed: 2 years ago
Flags: needinfo?(chutten)
Resolution: --- → INVALID
You need to log in before you can comment on or make changes to this bug.