Skip to content

[v12] Fixes to metrics docs#24290

Merged
pschisa merged 3 commits intobranch/v12from
bot/backport-24200-branch/v12
Apr 7, 2023
Merged

[v12] Fixes to metrics docs#24290
pschisa merged 3 commits intobranch/v12from
bot/backport-24200-branch/v12

Conversation

@pschisa
Copy link
Copy Markdown
Contributor

@pschisa pschisa commented Apr 7, 2023

Backport #24200 to branch/v12

pschisa and others added 3 commits April 7, 2023 18:39
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
~~~
* 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>
@public-teleport-github-review-bot public-teleport-github-review-bot Bot removed the request for review from alexfornuto April 7, 2023 19:46
@pschisa pschisa added this pull request to the merge queue Apr 7, 2023
Merged via the queue into branch/v12 with commit 0e683d4 Apr 7, 2023
@pschisa pschisa deleted the bot/backport-24200-branch/v12 branch April 7, 2023 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants