Preferences and Defines¶
This determines whether the Glean SDK is enabled.
It can be controlled by users via
If this is set to false from true, we send a
and no data collections will be persisted or reported from that point.
If set to a value
port which is greater than 0, pings will be sent to
http://localhost:port instead of
If set to a value which is less than 0,
FOG will take all pings scheduled for upload and drop them on the floor,
telling the Glean SDK that it was sent successfully.
This is how you emulate “recording enabled but upload disabled”
like developer builds have in Firefox Telemetry.
Defaults to 0.
This pair of prefs control the length of time of activity before inactivity (or vice versa) needed before FOG informs the SDK’s Client Activity API that the client was (in)active. Present to allow testing without figuring out how to mock Rust’s clock. Their values are integer seconds. Defaults to 120 (activity), 1200 (inactivity).
If set, recording Glean metrics are a no-op. Glean will not be initialized.
Only set on Android.
This define will be removed after we sort out how Android and Geckoview will work
(see bug 1670261).
It can be queried in C++ via
and in JS via
If unset, we set a
glean_disable_upload Rust feature in
gkrust-shared which is forwarded to
This feature defaults FOG to an “upload disabled”
mode where collection on the client proceeds as normal but no ping is sent.
This mode can be overridden at runtime in two ways:
If the preference
telemetry.fog.test.localhost_portis set to a value greater than 0, then pings are sent to a server operating locally at that port (even if the ping has a Debug Tag), to enable testing.
MOZILLA_OFFICIAL tends to be set on most builds released to users,
including builds distributed by Linux distributions.
It tends to not be set on local developer builds.
See bug 1680025 for details.