Docs: add flag var and extra detail for debug#24242
Merged
alexfornuto merged 2 commits intopschisa-patch-4from Apr 7, 2023
Merged
Docs: add flag var and extra detail for debug#24242alexfornuto merged 2 commits intopschisa-patch-4from
alexfornuto merged 2 commits intopschisa-patch-4from
Conversation
alexfornuto
changed the title
alexfornuto
requested review from
pschisa and
rosstimothy
and removed request for
r0mant,
xinding33 and
zmb3
zmb3
reviewed
Apr 6, 2023
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
rosstimothy
approved these changes
Apr 6, 2023
pschisa
approved these changes
Apr 6, 2023
pschisa
added a commit
that referenced
this pull request
Apr 7, 2023
* Fixes to metrics docs Based on my testing, setting Teleport in debug mode is not required to expose the metrics ~~~ # cat /etc/systemd/system/teleport.service ExecStart=/usr/local/bin/teleport start --config=/etc/teleport.yaml --diag-addr=http://172.31.36.239:3434 --pid-file=/run/teleport/teleport.pid # cat /etc/teleport.yaml teleport: log: severity: INFO # curl http://172.31.36.239:3434/metrics | more % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0# HELP audit_failed_disk_monitoring Number of times disk monitoring failed. # TYPE audit_failed_disk_monitoring counter audit_failed_disk_monitoring 0 # HELP audit_failed_emit_events Number of times emitting audit event failed. # TYPE audit_failed_emit_events counter audit_failed_emit_events 0 # HELP audit_percentage_disk_space_used Percentage disk space used. # TYPE audit_percentage_disk_space_used gauge audit_percentage_disk_space_used 100 # HELP audit_server_open_files Number of open audit files # TYPE audit_server_open_files gauge audit_server_open_files 0 ... ~~~ Also, curling the diag endpoint without the metrics part returns a 404 page not found which is a confusing way to validate it is working ~~~ # curl http://172.31.36.239:3434/ 404 page not found ~~~ * Docs: add flag var and extra detail for debug (#24242) * add flag var and extra detail for debug * Update docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update diag-addr-prereqs-tabs.mdx --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
github-actions Bot
pushed a commit
that referenced
this pull request
Apr 7, 2023
* add flag var and extra detail for debug * Update docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
pschisa
added a commit
that referenced
this pull request
Apr 7, 2023
* Fixes to metrics docs Based on my testing, setting Teleport in debug mode is not required to expose the metrics ~~~ # cat /etc/systemd/system/teleport.service ExecStart=/usr/local/bin/teleport start --config=/etc/teleport.yaml --diag-addr=http://172.31.36.239:3434 --pid-file=/run/teleport/teleport.pid # cat /etc/teleport.yaml teleport: log: severity: INFO # curl http://172.31.36.239:3434/metrics | more % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0# HELP audit_failed_disk_monitoring Number of times disk monitoring failed. # TYPE audit_failed_disk_monitoring counter audit_failed_disk_monitoring 0 # HELP audit_failed_emit_events Number of times emitting audit event failed. # TYPE audit_failed_emit_events counter audit_failed_emit_events 0 # HELP audit_percentage_disk_space_used Percentage disk space used. # TYPE audit_percentage_disk_space_used gauge audit_percentage_disk_space_used 100 # HELP audit_server_open_files Number of open audit files # TYPE audit_server_open_files gauge audit_server_open_files 0 ... ~~~ Also, curling the diag endpoint without the metrics part returns a 404 page not found which is a confusing way to validate it is working ~~~ # curl http://172.31.36.239:3434/ 404 page not found ~~~ * Docs: add flag var and extra detail for debug (#24242) * add flag var and extra detail for debug * Update docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update diag-addr-prereqs-tabs.mdx --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This is an attempt to solve the issue @rosstimothy brought up with #24200.