File: geckoview-streaming.rst

package info (click to toggle)
firefox-esr 115.15.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,659,216 kB
  • sloc: cpp: 6,676,686; javascript: 5,690,965; ansic: 3,328,546; python: 1,120,594; asm: 397,163; xml: 180,531; java: 178,838; sh: 68,930; makefile: 20,999; perl: 12,595; objc: 12,561; yacc: 4,583; cs: 3,846; pascal: 2,840; lex: 1,720; ruby: 1,079; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10
file content (26 lines) | stat: -rw-r--r-- 1,218 bytes parent folder | download | duplicates (22)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
GeckoView Streaming API
=======================

As an alternative to the normal mode where Firefox Desktop records and sends data,
Telemetry can instead route Histogram samples and Scalar values out of Gecko to a Telemetry Delegate.

To do this, ``toolkit.telemetry.geckoview.streaming`` must be set to true,
and Gecko must have been built with ``MOZ_WIDGET_ANDROID`` defined.

See :doc:`this guide <../start/report-gecko-telemetry-in-glean>`
for how to collect data in this mode.

Details
=======

Samples accumulated on Histograms and values set
(``ScalarAdd`` and ``ScalarSetMaximum`` operations are not supported)
on Scalars that have ``products`` lists that include ``geckoview_streaming``
will be redirected to a small batching service in
``toolkit/components/telemetry/geckoview/streaming``.
The batching service
(essentially just tables of histogram/scalar names to lists of samples/values)
will hold on to these lists of samples/values paired to the histogram/scalar names for a length of time
(``toolkit.telemetry.geckoview.batchDurationMS`` (default 5000))
after which the next accumulation or ``ScalarSet`` will trigger the whole batch
(all lists) to be passed over to the ``StreamingTelemetryDelegate``.