Skip to content
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

Merged
merged 5 commits into from
Mar 23, 2019

Conversation

seanmalloy
Copy link
Contributor

@seanmalloy seanmalloy commented Mar 19, 2019

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.

@hashicorp-cla
Copy link

hashicorp-cla commented Mar 19, 2019

CLA assistant check
All committers have signed the CLA.

@riuvshin
Copy link

It seems that API Docs also should be updated: https://www.vaultproject.io/api/system/

@kalafut
Copy link
Contributor

kalafut commented Mar 19, 2019

@seanmalloy re: the OpenAPI output, query parameters in general aren't being handled correctly. I'll look into fixing that.

@seanmalloy seanmalloy force-pushed the fix-prom-metrics-docs branch 2 times, most recently from 92fe1da to 0989f65 Compare March 20, 2019 03:01
@seanmalloy
Copy link
Contributor Author

I added the missing API docs for /v1/sys/metrics. Let me know if any changes are needed.

@kalafut kalafut self-assigned this Mar 22, 2019
@kalafut
Copy link
Contributor

kalafut commented Mar 22, 2019

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 metrics before mounts here:

I'll handle the OpenAPI updates separately.

seanmalloy and others added 4 commits March 22, 2019 20:51
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>
@seanmalloy seanmalloy force-pushed the fix-prom-metrics-docs branch from ee24cd0 to 763bb10 Compare March 23, 2019 01:51
@seanmalloy
Copy link
Contributor Author

@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.

@kalafut kalafut merged commit ffd437a into hashicorp:master Mar 23, 2019
@kalafut
Copy link
Contributor

kalafut commented Mar 23, 2019

@seanmalloy Looks good, thanks again!

@kalafut
Copy link
Contributor

kalafut commented Mar 27, 2019

OpenAPI updates: #6490

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants