Backport of improve client RPC metrics consistency into release/1.17.x #19843
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.
Backport
This PR is auto-generated from #19721 to be assessed for backporting due to the inclusion of the label backport/1.17.
The below text is copied from the body of the original PR.
The client.rpc metric now excludes internal retries for consistency with client.rpc.exceeded and client.rpc.failed. All of these metrics now increment at most once per RPC method call, allowing for accurate calculation of failure / rate limit application occurrence.
Additionally, if an RPC fails because no servers are present, client.rpc.failed is now incremented.
Note: The client.rpc.failed metric used to increment on internal retries as well, but that was changed in this commit (CC @kisunji).
Testing & Reproduction steps
Manual testing conducted by reviewer (@rboyer).
curl -sL -XPUT 172.17.0.3:8500/v1/catalog/register -d'{"Node":"foo", "Address":"4.4.4.4", "ID":"blah"}'
. Note: this should succeed on the first try.curl -sL '172.17.0.3:8500/v1/catalog/nodes?filter=^^^''
. Note: this should fail and have several internal retries.$ curl -sL 172.17.0.3:8500/v1/agent/metrics | jq '.Counters[] | select (.Name | test("^consul\\.client\\.rpc"))'
Expect:
consul.client.rpc
: 2consul.client.rpc.failed
: 1Actual: Matches expectation
PR Checklist
Additional Notes
Added the
pr/no-metrics-test
label since the affected metric predates that CI check, currently has no tests, and correct behavior was manually verified as a part of this review.Overview of commits