Add a guide to metrics for monitoring Teleport #46645
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ptgott
added
no-changelog
github-actions
bot
requested review from
mmcallister,
r0mant,
xinding33 and
zmb3
|
🤖 Vercel preview here: https://docs-hwwmn4qux-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/40664-monitoring
branch
from
7f35bb1
to
7443fd8
Compare
|
🤖 Vercel preview here: https://docs-3vr59qbq9-goteleport.vercel.app/docs/ver/preview |
mmcallister
reviewed
Sep 18, 2024
| The backend throughput metrics discussed in the previous section map on to | ||
| latency metrics. Whenever the Auth Service increments one of the throughput | ||
| metrics, it reports one of the corresponding latency metrics. See the table | ||
| below for which throughput metrics miap to which latency metrics. Each metric |
There was a problem hiding this comment.
Suggested change
| below for which throughput metrics miap to which latency metrics. Each metric | |
| below for which throughput metrics map to which latency metrics. Each metric |
mmcallister
approved these changes
Sep 18, 2024
ptgott
force-pushed
the
paul.gottschling/40664-monitoring
branch
from
7443fd8
to
b6b8d4f
Compare
mmcallister
approved these changes
Sep 19, 2024
ptgott
force-pushed
the
paul.gottschling/40664-monitoring
branch
from
b6b8d4f
to
6a52832
Compare
|
🤖 Vercel preview here: https://docs-et5246prw-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/40664-monitoring
branch
from
6a52832
to
6f602be
Compare
|
🤖 Vercel preview here: https://docs-civ0o1ngr-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/40664-monitoring
branch
from
6f602be
to
4d69a4f
Compare
|
🤖 Vercel preview here: https://docs-g60stgyxr-goteleport.vercel.app/docs/ver/preview |
|
@evanfreed I've added new information based on your feedback. Checking to make sure it's accurate. Thanks! |
evanfreed
approved these changes
Oct 8, 2024
public-teleport-github-review-bot
bot
removed request for
r0mant,
jimbishopp,
zmb3,
strideynet and
xinding33
ptgott
force-pushed
the
paul.gottschling/40664-monitoring
branch
from
c888cf2
to
dd0d4f9
Compare
Closes #40664 This change turns the Metrics guide in `admin-guides` into a conceptual guide to the most important metrics for monitoring a Teleport cluster. Since Agent metrics have inconsistent comprehensiveness across Teleport services--and to reduce the scope of this change--this guide focuses on self-hosted clusters. To make this a conceptual guide instead of a reference, this change removes the reference table from the `admin-guides` metrics page. There is already a table in the dedicated metrics reference guide. Note that, while the new metrics guide is specific to self-hosted clusters, this change does not move the guide to the subsection of Admin Guides related to self-hosting Teleport. Doing this would mean having one subsection of Admin Guides for diagnostics-related guides and one subsection for self-hosted-specific diagnostics, which is potentially confusing. We may also want to add Agent-specific metrics eventually. Finally, this change does not include alert thresholds for the metrics it describes. We can define these in a subsequent change.
- Describe `backend_write_requests_failed_precondition_total` - Include the precondition metric in the write availability formula. - Turn the `registered_servers` discussion into a discussion of Teleport instance version, since it's not possible to group this metric by service and subtract the count of Auth Service/Proxy Service instances from the count of all registered services.
ptgott
force-pushed
the
paul.gottschling/40664-monitoring
branch
from
dd0d4f9
to
da46d40
Compare
|
🤖 Vercel preview here: https://docs-qjwtm0d7k-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-jj68b6zag-goteleport.vercel.app/docs/ver/preview |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
This was referenced Oct 9, 2024
mvbrock
pushed a commit
that referenced
this pull request
Oct 16, 2024
* Add a guide to metrics for monitoring Teleport Closes #40664 This change turns the Metrics guide in `admin-guides` into a conceptual guide to the most important metrics for monitoring a Teleport cluster. Since Agent metrics have inconsistent comprehensiveness across Teleport services--and to reduce the scope of this change--this guide focuses on self-hosted clusters. To make this a conceptual guide instead of a reference, this change removes the reference table from the `admin-guides` metrics page. There is already a table in the dedicated metrics reference guide. Note that, while the new metrics guide is specific to self-hosted clusters, this change does not move the guide to the subsection of Admin Guides related to self-hosting Teleport. Doing this would mean having one subsection of Admin Guides for diagnostics-related guides and one subsection for self-hosted-specific diagnostics, which is potentially confusing. We may also want to add Agent-specific metrics eventually. Finally, this change does not include alert thresholds for the metrics it describes. We can define these in a subsequent change. * Respond to evanfreed feedback - Describe `backend_write_requests_failed_precondition_total` - Include the precondition metric in the write availability formula. - Turn the `registered_servers` discussion into a discussion of Teleport instance version, since it's not possible to group this metric by service and subtract the count of Auth Service/Proxy Service instances from the count of all registered services.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #40664
This change turns the Metrics guide in
admin-guidesinto a conceptual guide to the most important metrics for monitoring a Teleport cluster.Since Agent metrics have inconsistent comprehensiveness across Teleport services--and to reduce the scope of this change--this guide focuses on self-hosted clusters.
To make this a conceptual guide instead of a reference, this change removes the reference table from the
admin-guidesmetrics page. There is already a table in the dedicated metrics reference guide.Note that, while the new metrics guide is specific to self-hosted clusters, this change does not move the guide to the subsection of Admin Guides related to self-hosting Teleport. Doing this would mean having one subsection of Admin Guides for diagnostics-related guides and one subsection for self-hosted-specific diagnostics, which is potentially confusing. We may also want to add Agent-specific metrics eventually.
Finally, this change does not include alert thresholds for the metrics it describes. We can define these in a subsequent change.