Update troubleshooting guides with debug service usage #41396
Conversation
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-5ggucvrpx-goteleport.vercel.app/docs/ver/preview |
gabrielcorado
added
the
no-changelog
|
🤖 Vercel preview here: https://docs-rc57pd32l-goteleport.vercel.app/docs/ver/preview |
| @@ -18,6 +18,29 @@ services such as the Application Service and Database Service. | |||
|
|
|||
| ## Step 1/3. Enable verbose logging | |||
|
|
|||
| <Tabs> | |||
There was a problem hiding this comment.
In this Tabs component, I don't think there's a way for the user to tell which tab to choose without looking at both tabs. I would either:
- Explain when a user would choose a particular tab before the Tabs component
- Include both possibilities as separate H3 sections and provide context before the first H3.
There was a problem hiding this comment.
I've added a short description of both methods.
| @@ -33,6 +56,8 @@ teleport: | |||
| Restart the `teleport` process to apply the modified log level. Logs will resemble | |||
| the following (these logs were printed while joining a server to a cluster, then | |||
| terminating the `teleport` process on the server): | |||
| </TabItem> | |||
| </Tabs> | |||
|
|
|||
| ``` | |||
There was a problem hiding this comment.
Since these are examples of verbose logging, should we associate them with the "Updating configuration" instructions? Otherwise, they seem to be sitting here with no context.
There was a problem hiding this comment.
Both flows will change the log levels verbosity. I've moved the paragraph from below the logs example, so it gives context and then shows the example.
| @@ -18,6 +18,29 @@ services such as the Application Service and Database Service. | |||
|
|
|||
| ## Step 1/3. Enable verbose logging | |||
|
|
|||
| <Tabs> | |||
| <TabItem label="With Debug service"> | |||
| (!docs/pages/includes/diagnostics/debug-service-intro.mdx!) | |||
There was a problem hiding this comment.
From what I gather, the Debug Service does the same thing as enabling verbose logging. Is that true? If not, these instructions should make it clear what starts happening when the Debug Service runs.
There was a problem hiding this comment.
In this context, yes. I've updated both places that have a debug service intro so they can be more focused on the use case.
|
🤖 Vercel preview here: https://docs-7ux0bw4oj-goteleport.vercel.app/docs/ver/preview |
| $ go tool trace trace.pprof | ||
| ``` | ||
|
|
||
| (!docs/pages/includes/diagnostics/teleport-debug-config.mdx!) |
There was a problem hiding this comment.
teleport-debug-config.mdx can be placed up a little? maybe before kube instruction or before visualization section?
public-teleport-github-review-bot
bot
removed request for
r0mant,
zmb3 and
xinding33
Co-authored-by: Paul Gottschling <[email protected]>
|
🤖 Vercel preview here: https://docs-po9y7r331-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-1oxoovdrk-goteleport.vercel.app/docs/ver/preview |
Updates guides on collection pprof profiles and changing Teleport's log level to include the debug service usage.