Charmhub: Request recorder collector #13089
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
This is the initial WIP for passing in the request recorder through the layers to get metrics from queries.
The following creates a request recorder for the charmhub client. It doesn't really do much atm, but shows that it is possible from the facade layers.
The following ensures that we have single responsibility for logging when performing API requests. The default HTTP transport will also give you a logging request recorder, this should aid with always having a request recorder for making charmhub requests. As all the above is handled only when trace is enabled shouldn't impact performance.
The following wires up the outbound total requests API metrics. It uses the juju/http request recorder. We have to be extra careful about what we want to use as labels, we don't want to log the path or the complete URL for a couple of reasons: 1. Security around what can be in a URL; auth tokens et al 2. We don't want to balloon the cardinality of the database. With this in mind, we want to just request the host names for now, which keeps the cardinality low.
The charms facade also uses the same setup/creation as charmhub facade, so makes sense to do it in the same PR.
SimonRichardson
force-pushed
the
request-recorder-collector
branch
from
ecbae8e to
037c203
Compare
manadart
requested changes
Jun 18, 2021
| func (w httpRequestRecorderWrapper) Record(method string, url *url.URL, res *http.Response, rtt time.Duration) { | ||
| // Note: Do not log url.Path as REST queries _can_ include the name of the | ||
| // entities (charms, architectures, etc). | ||
| w.collector.TotalRequests.WithLabelValues(w.modelUUID, url.Host, strconv.FormatInt(int64(res.StatusCode), 10)).Inc() |
There was a problem hiding this comment.
I would make helpers for these - uniform access principle. Also means you don't refer to multiple members in a call.
There was a problem hiding this comment.
Generally agree but in this case (just two call sites) it seems to me like overkill to add helpers.
The newRoot constructor took a various amount of different root types. Instead of this, we just make apiHandler conform to an interface and then we can just select the types off of that. The test version was also easy to construct, just create an empty type and pass back nil in most cases or a dummy resource container. This should make the readability of a newRoot type easier to understand.
The following are fixes to linting issues.
SimonRichardson
changed the title
|
|
jujubot
added a commit
that referenced
this pull request
Jun 22, 2021
#13094 Merge from 2.9 to bring forward: - #13093 from manadart/2.9-machine-agent-test-race - #13092 from hpidcock/fix-1929364 - #13089 from SimonRichardson/request-recorder-collector - #13088 from SimonRichardson/leadership-context - #13075 from manadart/2.9-net-get-machine - #13081 from jujubot/increment-to-2.9.6 Only conflicts were the usual trivial ones in the version files.
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.
The following wires up the outbound total requests API metrics. It uses
the juju/http request recorder.
We have to be extra careful about what we want to use as labels, we
don't want to log the path or the complete URL for a couple of reasons:
With this in mind, we want to just request the hostnames for now, which
keeps the cardinality low.
Additionally, we have single responsibility for logging when performing
API requests.
The default HTTP transport will also give you a logging request
recorder, this should aid with always having a request recorder for
making charmhub requests.
As all the above is handled only when trace is enabled shouldn't impact
performance.
QA steps
Setup
Query
Note: you need to query first to show any outbound information. The metrics
are lazily created.
Bug reference