Skip to content

Commit

Permalink
DOC-11414 PR #132257 - diagnostics: check license and diagnostics set…
Browse files Browse the repository at this point in the history
…tings for cluster report (#19008)

* In diagnostics-reporting.md, added note to ignore cluster setting with Trial or Free licenses.

* Incorporated Kathryn and Rich’s feedback.
  • Loading branch information
florence-crl authored Oct 21, 2024
1 parent a2c0113 commit 0758a6b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/current/v24.3/diagnostics-reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ In all cases, names and other string values are scrubbed and replaced with under

## Opt out of diagnostics reporting

{{site.data.alerts.callout_info}}
Diagnostics reporting is required for [**Enterprise Trial** or **Enterprise Free** licenses]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses). Therefore, the cluster setting `diagnostics.reporting.enabled` is ignored on clusters with these licenses. The following opt-out methods apply only to clusters with an [**Enterprise** license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses).
{{site.data.alerts.end}}

### At cluster initialization

To make sure that absolutely no diagnostic details are shared, you can set the environment variable `COCKROACH_SKIP_ENABLING_DIAGNOSTIC_REPORTING=true` before starting the first node of the cluster. Note that this works only when set before starting the first node of the cluster. Once the cluster is running, you need to use the `SET CLUSTER SETTING` method described below.
Expand Down

0 comments on commit 0758a6b

Please sign in to comment.