Commit Graph
2 Commits
Author SHA1 Message Date
rosstimothyandZac Bergquist 9646ce4d2c Add documentation for tsh --trace-exporter (#22791)
* Add documentation for `tsh --trace-exporter`

Includes details on how to collect traces from `tsh` that are not
exported to the auth service. This can be especially helpful to
retrieve traces from `tsh` when the `tracing_service` has not been
enabled in the cluster.

* Update docs/pages/management/diagnostics/tracing.mdx

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-03-08 22:12:03 +00:00
rosstimothy f591236b33 Enhance diagnostics docs (#15648)
* Enhance diagnostics docs

The diagnostics docs were all in one page(`setup/reference/metrics.mdx`)
which made things a bit hard to find, and wasn't conducive to adding
new content.

Diagnostics information is now located at `setup/diagnostics` with each
section from the original `metrics.mdx` doc now having its own dedicated
page. The section will now show up in the navbar at
"Setup" > "Monitoring Your Cluster".

The content of the profiling page is expanded to include information from
https://github.com/gravitational/teleport/blob/740d184d1cfc69ae2e96c50ee738b13884fb232b/assets/monitoring/README.md#low-level-monitoring
to illustrate what the different profile types are, the information that
they capture, and how to retrieve them.

A new Distributed Tracing page is also added to instruct users on how to setup
the `tracing_service` to collect and export spans (the last open item
for #12241).
2022-10-14 20:05:07 +00:00