summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/docs/data/modules-ping.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /toolkit/components/telemetry/docs/data/modules-ping.rst
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/telemetry/docs/data/modules-ping.rst')
-rw-r--r--toolkit/components/telemetry/docs/data/modules-ping.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/toolkit/components/telemetry/docs/data/modules-ping.rst b/toolkit/components/telemetry/docs/data/modules-ping.rst
new file mode 100644
index 0000000000..c3b193f8dc
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/modules-ping.rst
@@ -0,0 +1,46 @@
+
+"modules" ping
+==============
+
+This ping is sent once a week and includes the modules loaded in the Firefox process.
+
+The client ID and environment are submitted with this ping.
+
+Structure:
+
+.. code-block:: js
+
+ {
+ type: "modules",
+ ... common ping data
+ clientId: <UUID>,
+ environment: { ... },
+ payload: {
+ version: 1,
+ modules: [
+ {
+ name: <string>, // Name of the module file (e.g. xul.dll)
+ version: <string>, // Version of the module
+ debugID: <string>, // ID of the debug information file
+ debugName: <string>, // Name of the debug information file
+ certSubject: <string>, // Name of the organization that signed the binary (Optional, only defined when present)
+ },
+ ...
+ ],
+ }
+ }
+
+Notes
+~~~~~
+
+The version information is only available on Windows, it is null on other platforms.
+
+The debug name is the name of the PDB on Windows (which isn't always the same as the module name modulo the extension, e.g. the PDB for C:\Windows\SysWOW64\ntdll.dll is wntdll.pdb) and is the same as the module name on other platforms.
+
+The debug ID is platform-dependent. It is compatible with the Breakpad ID used on Socorro.
+
+Sometimes the debug name and debug ID are missing for Windows modules (often with malware). In this case, they will be "null".
+
+The length of the modules array is limited to 512 entries.
+
+The name and debug name are length limited, with a maximum of 64 characters.