Skip to content

Commit

Permalink
docs: warn in task page that live debugging must be enabled (#1150)
Browse files Browse the repository at this point in the history
Co-authored-by: Clayton Cornell <[email protected]>
  • Loading branch information
rfratto and clayton-cornell authored Jun 26, 2024
1 parent e0dcf42 commit 29a6c32
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/sources/tasks/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,12 @@ The clustering page shows the following information for each cluster node:

Live debugging provides a real-time stream of debugging data from a component. You can access this page from the corresponding [Component detail page](#component-detail-page).

{{< admonition type="caution" >}}
Live debugging is disabled by default to avoid accidentally displaying sensitive telemetry data. To enable live debugging, configure the [livedebugging block][livedebugging].

[livedebugging]: ../../reference/config-blocks/livedebugging/
{{< /admonition >}}

Live debugging allows you to do the following:

* Pause and clear the data stream.
Expand Down

0 comments on commit 29a6c32

Please sign in to comment.