DOC-11718 PR #134993 - ui: add Redact option to stmt diag activation …

…modal (#19254)

* In statement-bundle-warning.md common include file, mentioned that users can redact data in statement bundles in v24.3.1 or later.

In v24.3 and v25.1 statement-details.md, updated Diagnostics section to include plan gist and redact options.

In v23.2, v24.2, and v24.2, statement-details.md, updated Diagnostics section to include plan gist option.

* Incorporated Kathryn’s feedback.

src/current/_includes/common/sql/statement-bundle-warning.md

@@ -1,5 +1,7 @@
 {{site.data.alerts.callout_danger}}Statement bundles can contain unredacted user data including histograms and placeholders that contain real data samples, statements that have real data which can contain PII information, and database schema that could be sensitive. Be careful when generating and sharing statement bundles.
 
+<br><br>In CockroachDB v24.3.1 and later, <code>admin</code> users or SQL users with the <code>VIEWACTIVITY</code> system privilege can choose to redact user data from the <a href="{{ link_prefix }}ui-statements-page.html#activate-diagnostics-collection-and-download-bundles"><b>Activate statement diagnostics</b></a> dialog.
+
 <br><br>To allow or disallow a role from seeing <a href="{{ link_prefix }}ui-statements-page.html#diagnostics">statements diagnostics bundles</a>, set the <code>VIEWACTIVITYREDACTED</code> <a href="{{ link_prefix }}create-role.html#role-options">role option</a>.
 
 <br><br>In CockroachDB v21.2.x, v22.1.0 to v22.1.16, v22.2.0 to v22.2.6, non-admin SQL users with an authenticated HTTP session could download statement diagnostic bundles given a bundle URL from the DB Console or the <code>EXPLAIN ANALYZE (DEBUG)</code> statement with a valid HTTP session cookie. This has been resolved in v22.1.17 and v22.2.7. For more information, see the <a href="../advisories/a99049.html">Technical Advisory A99049</a>.

src/current/_includes/v23.2/ui/statement-details.md

@@ -155,6 +155,9 @@ To activate diagnostics collection:
 1. Choose whether to:
    1. trace and collect diagnostics at the default sampled rate of 1% (or specify a different rate) when the statement execution latency exceeds the default time of 100 milliseconds (or specify a different time), or
    1. trace and collect diagnostics on the next statement execution.
+1. Choose whether to collect diagnostics:
+   1. For all plan gists, or
+   1. For a particular plan gist (select one from the dropdown list).
 1. Choose whether the request should expire after 15 minutes, or after a different time, or disable automatic expiration by deselecting the checkbox. Executions of the same statement fingerprint will run slower while diagnostics are activated, so it is recommended to set an expiration time if collecting according to a latency threshold.
 1. Click **Activate**.
 

src/current/_includes/v24.1/ui/statement-details.md

@@ -150,6 +150,9 @@ To activate diagnostics collection:
 1. Choose whether to:
    1. trace and collect diagnostics at the default sampled rate of 1% (or specify a different rate) when the statement execution latency exceeds the default time of 100 milliseconds (or specify a different time), or
    1. trace and collect diagnostics on the next statement execution.
+1. Choose whether to collect diagnostics:
+   1. For all plan gists, or
+   1. For a particular plan gist (select one from the dropdown list).
 1. Choose whether the request should expire after 15 minutes, or after a different time, or disable automatic expiration by deselecting the checkbox. Executions of the same statement fingerprint will run slower while diagnostics are activated, so it is recommended to set an expiration time if collecting according to a latency threshold.
 1. Click **Activate**.
 

src/current/_includes/v24.2/ui/statement-details.md

@@ -150,6 +150,9 @@ To activate diagnostics collection:
 1. Choose whether to:
    1. trace and collect diagnostics at the default sampled rate of 1% (or specify a different rate) when the statement execution latency exceeds the default time of 100 milliseconds (or specify a different time), or
    1. trace and collect diagnostics on the next statement execution.
+1. Choose whether to collect diagnostics:
+   1. For all plan gists, or
+   1. For a particular plan gist (select one from the dropdown list).
 1. Choose whether the request should expire after 15 minutes, or after a different time, or disable automatic expiration by deselecting the checkbox. Executions of the same statement fingerprint will run slower while diagnostics are activated, so it is recommended to set an expiration time if collecting according to a latency threshold.
 1. Click **Activate**.
 

src/current/_includes/v24.3/ui/statement-details.md

@@ -150,7 +150,11 @@ To activate diagnostics collection:
 1. Choose whether to:
    1. trace and collect diagnostics at the default sampled rate of 1% (or specify a different rate) when the statement execution latency exceeds the default time of 100 milliseconds (or specify a different time), or
    1. trace and collect diagnostics on the next statement execution.
+1. Choose whether to collect diagnostics:
+   1. For all plan gists, or
+   1. For a particular plan gist (select one from the dropdown list).
 1. Choose whether the request should expire after 15 minutes, or after a different time, or disable automatic expiration by deselecting the checkbox. Executions of the same statement fingerprint will run slower while diagnostics are activated, so it is recommended to set an expiration time if collecting according to a latency threshold.
+1. {% include_cached new-in.html version="v24.3.1" %}Choose to **Redact** sensitive user data, such as histograms, placeholders, statements, and traces that have real data which can contain PII information.
 1. Click **Activate**.
 
 When the statement fingerprint is executed according to the statement diagnostic options selected, a row with the activation time and collection status is added to the **Statement diagnostics** table.

src/current/_includes/v25.1/ui/statement-details.md

@@ -150,7 +150,11 @@ To activate diagnostics collection:
 1. Choose whether to:
    1. trace and collect diagnostics at the default sampled rate of 1% (or specify a different rate) when the statement execution latency exceeds the default time of 100 milliseconds (or specify a different time), or
    1. trace and collect diagnostics on the next statement execution.
+1. Choose whether to collect diagnostics:
+   1. For all plan gists, or
+   1. For a particular plan gist (select one from the dropdown list).
 1. Choose whether the request should expire after 15 minutes, or after a different time, or disable automatic expiration by deselecting the checkbox. Executions of the same statement fingerprint will run slower while diagnostics are activated, so it is recommended to set an expiration time if collecting according to a latency threshold.
+1. Choose to **Redact** sensitive user data, such as histograms, placeholders, statements, and traces that have real data which can contain PII information.
 1. Click **Activate**.
 
 When the statement fingerprint is executed according to the statement diagnostic options selected, a row with the activation time and collection status is added to the **Statement diagnostics** table.