Skip to content

[v12] Fixes to metrics docs #24290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pschisa merged 3 commits into from
Apr 7, 2023
Merged

[v12] Fixes to metrics docs #24290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad65a89
Fixes to metrics docs
pschisa Apr 6, 2023
8abe673
Docs: add flag var and extra detail for debug (#24242)
Apr 7, 2023
eb89bbc
Update diag-addr-prereqs-tabs.mdx
pschisa Apr 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{{ flags="" }}
Teleport's diagnostic HTTP endpoints are disabled by default. You can enable
them via:

Expand All @@ -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
```

</TabItem>
<TabItem label="Config file">
Edit a `teleport` instance's configuration file (`/etc/teleport.yaml` by
Expand All @@ -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
```

</TabItem>
</Tabs>

Expand All @@ -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
```
</Details>
2 changes: 1 addition & 1 deletion docs/pages/management/diagnostics/profiles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down