summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/docs/data/xfocsp-error-report-ping.rst
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/telemetry/docs/data/xfocsp-error-report-ping.rst
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/telemetry/docs/data/xfocsp-error-report-ping.rst')
-rw-r--r--toolkit/components/telemetry/docs/data/xfocsp-error-report-ping.rst69
1 files changed, 69 insertions, 0 deletions
diff --git a/toolkit/components/telemetry/docs/data/xfocsp-error-report-ping.rst b/toolkit/components/telemetry/docs/data/xfocsp-error-report-ping.rst
new file mode 100644
index 0000000000..f1b6f928a3
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/xfocsp-error-report-ping.rst
@@ -0,0 +1,69 @@
+
+"xfocsp-error-report" ping
+==========================
+
+This opt-in ping is sent when an X-Frame-Options error or a CSP: frame-ancestors
+happens to report the error. Users can opt-in this by checking the reporting
+checkbox. After users opt-in, this ping will be sent every time the error
+happens. Users can opt-out this by un-checking the reporting checkbox on the
+error page. The client_id and environment are not sent with this ping.
+
+Structure:
+
+.. code-block:: js
+
+ {
+ "type": "xfocsp-error-report",
+ ... common ping data
+ "payload": {
+ "error_type": <string>,
+ "xfo_header": <string>,
+ "csp_header": <string>,
+ "frame_hostname": <string>,
+ "top_hostname": <string>,
+ "frame_uri": <string>,
+ "top_uri": <string>,
+ }
+ }
+
+info
+----
+
+error_type
+~~~~~~~~~~
+
+The type of what error triggers this ping. This could be either "xfo" or "csp".
+
+xfo_header
+~~~~~~~~~~
+
+The X-Frame-Options value in the response HTTP header.
+
+csp_header
+~~~~~~~~~~
+
+The CSP: frame-ancestors value in the response HTTP header.
+
+frame_hostname
+~~~~~~~~~~~~~~
+
+The hostname of the frame which triggers the error.
+
+top_hostname
+~~~~~~~~~~~~
+
+The hostname of the top-level page which loads the frame.
+
+frame_uri
+~~~~~~~~~
+
+The uri of the frame which triggers the error. This excludes the query strings.
+
+top_uri
+~~~~~~~
+
+The uri of the top-level page which loads the frame. This excludes the query
+strings.
+
+
+See also: :doc:`common ping fields <common-ping>`