-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
Add Docs For Prometheus Metrics #6434
Conversation
It seems that API Docs also should be updated: https://www.vaultproject.io/api/system/ |
@seanmalloy re: the OpenAPI output, query parameters in general aren't being handled correctly. I'll look into fixing that. |
92fe1da
to
0989f65
Compare
I added the missing API docs for /v1/sys/metrics. Let me know if any changes are needed. |
This looks good! Thanks for putting it together. I left a few inline comments. In addition, since the metrics page is new, there is another change needed in order for it to show up in the sidebar. Please add vault/website/source/layouts/api.erb Line 117 in 3af9be4
I'll handle the OpenAPI updates separately. |
Prometheus metrics were added as part of the Vault v1.1.0 release in PR hashicorp#5308. But no documentation was created. Adds the telemetry configuration docs and the API docs.
Co-Authored-By: seanmalloy <spinelli85@gmail.com>
Co-Authored-By: seanmalloy <spinelli85@gmail.com>
ee24cd0
to
763bb10
Compare
@kalafut thanks for the review. I have addressed all of your review comments. Let me know if you want me to clean up the commit history before merging. |
@seanmalloy Looks good, thanks again! |
OpenAPI updates: #6490 |
Prometheus metrics were added as part of the Vault v1.1.0 release in PR #5308. But no documentation was created. Adds the telemetry configuration docs and the API docs.