summaryrefslogtreecommitdiffstats
path: root/toolkit/components/glean/docs/preferences.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /toolkit/components/glean/docs/preferences.md
parentInitial commit. (diff)
downloadfirefox-upstream.tar.xz
firefox-upstream.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/glean/docs/preferences.md')
-rw-r--r--toolkit/components/glean/docs/preferences.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/toolkit/components/glean/docs/preferences.md b/toolkit/components/glean/docs/preferences.md
new file mode 100644
index 0000000000..1a0efffc10
--- /dev/null
+++ b/toolkit/components/glean/docs/preferences.md
@@ -0,0 +1,21 @@
+# Preferences
+
+## User Preferences
+
+`datareporting.healthreport.uploadEnabled`
+
+This determines whether the Glean SDK is enabled.
+It can be controlled by users via `about:preferences#privacy`.
+If this is set to false from true, we send a
+["deletion-request" ping](https://mozilla.github.io/glean/book/user/pings/deletion_request.html)
+and no data collections will be persisted or reported from that point.
+
+## Test-only Preferences
+
+`telemetry.fog.test.localhost_port`
+
+If set to a value `port` which is greater than 0, pings will be sent to
+`http://localhost:port` instead of `https://incoming.telemetry.mozilla.org`.
+If set to a value which is less than 0, FOG will not squelch all sent pings,
+telling the Glean SDK that the ping was sent successfully.
+Defaults to 0.