Adding docs for prometheus. #507
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
openshift-ci-robot
added
the
size/S
eriknelson
reviewed
Oct 19, 2017
docs/troubleshooting.md
Outdated
| 1. asb_sandbox - Keeps track of the active sandboxes | ||
| 2. asb_specs_loaded - will keep track of the number of specs currently loaded, will be reset on bootstrap. Labels can be used to determine the registry that has X number loaded. | ||
| 3. asb_spec_reset - will keep track of how many times the specs have been reset. | ||
| 4. asb_provision_jobs - will keep track of how many jobs are currently in the provision buffer? |
djzager
approved these changes
Oct 19, 2017
| @@ -188,3 +188,27 @@ Redeploy the broker using origin clients `rollout latest` command. | |||
| $ oc rollout latest asb | |||
| deploymentconfig "asb" rolled out | |||
| ``` | |||
|
|
|||
| ### Metrics | |||
docs/troubleshooting.md
Outdated
|
|
||
| ### Metrics | ||
|
|
||
| The broker will expose [Prometheus](https://prometheus.io/) style metrics that you can use to troubleshoot the broker if none of the steps above work. You can access the published metrics by calling: |
There was a problem hiding this comment.
Optional:
The broker exposes Prometheus style metrics for monitoring and troubleshooting purposes. You can access these metrics via the /metrics endpoint by calling:
Reason: It's infinitely useful by itself (as demonstrated already) and isn't conditional on the rest of the troubleshooting steps.
rthallisey
suggested changes
Oct 20, 2017
docs/troubleshooting.md
Outdated
| 3. asb_spec_reset - will keep track of how many times the specs have been reset. | ||
| 4. asb_provision_jobs - will keep track of how many jobs are currently in the provision buffer | ||
| 5. asb_deprovision_jobs - will keep track of how many jobs are currently in the deprovision buffer | ||
| 6. asb_update_jobs - will keep track of how many jobs are currently in the update buffer? |
There was a problem hiding this comment.
buffer? Drop off the question mark and add periods to all these.
docs/troubleshooting.md
Outdated
| 4. asb_provision_jobs - will keep track of how many jobs are currently in the provision buffer | ||
| 5. asb_deprovision_jobs - will keep track of how many jobs are currently in the deprovision buffer | ||
| 6. asb_update_jobs - will keep track of how many jobs are currently in the update buffer? | ||
| 5. asb_actions_requested - keeps track of the number of actions requested correctly (broken down by action = bind,unbind,update,provision,deprovision) |
There was a problem hiding this comment.
requested correctly I think I know what you mean by this, but can you say this another way?
I view this metric as: The total number of successful bind, unbind, update, provision, and deprovision requests. Each are labeled and can be filtered in a dashboard.
rthallisey
approved these changes
Oct 23, 2017
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.
Describe what this PR does and why we need it:
Adding documentation for using the metrics endpoint
NOTE: does the troubleshooting doc make sense?
Changes proposed in this pull request