diff --git a/docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx b/docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx index 5a7f504e0b02f..4ac4477ccb0f1 100644 --- a/docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx +++ b/docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx @@ -1,3 +1,4 @@ +{{ flags="" }} Teleport's diagnostic HTTP endpoints are disabled by default. You can enable them via: @@ -7,8 +8,9 @@ them via: address where the diagnostic endpoint will listen: ```code - $ sudo teleport start --debug --diag-addr=127.0.0.1:3000 + $ sudo teleport start {{ flags }} --diag-addr=127.0.0.1:3000 ``` + Edit a `teleport` instance's configuration file (`/etc/teleport.yaml` by @@ -17,10 +19,15 @@ them via: ```yaml teleport: diag_addr: 127.0.0.1:3000 + ``` + + To enable debug logs: - log: - severity: DEBUG + ```yaml + log: + severity: DEBUG ``` + @@ -32,6 +39,6 @@ them via: Verify that Teleport is now serving the diagnostics endpoint: ```code - $ curl http://127.0.0.1:3000 + $ curl http://127.0.0.1:3000/healthz ``` diff --git a/docs/pages/management/diagnostics/profiles.mdx b/docs/pages/management/diagnostics/profiles.mdx index 84b0ad1887069..08c9c7a70118e 100644 --- a/docs/pages/management/diagnostics/profiles.mdx +++ b/docs/pages/management/diagnostics/profiles.mdx @@ -11,7 +11,7 @@ the source of memory leaks, or the reason for a deadlock. The profiling endpoint is only enabled if the `--debug` flag is supplied. -(!docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx!) +(!docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx flags="--debug" !) ## Collecting profiles