Add metrics for external calls for the workflow ID specific rate limits. #5684
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 generates a rate limiter around the external calls in the history hander, generated using this command: .build/bin/gowrap gen -p ./service/history -i Handler -t ./service/history/templates/ratelimited.tmpl -o ./service/history/wrappers/ratelimited/handler_generated.go -v handler=History
When service and handler are in the same package we cannot introduce wrappers around handler in another package as that will create a circular dependency: history (service) -> wrapper -> history (handler) This moves handler to the handler package. Also moves the engine implementation to it's own package as there was a circular dependency history (service) -> handler -> history (engine) The engine implementation cannot be in the same package as the engine interface, as there is a dependency engineimpl -> shard -> engine (Interface) Moved all the error values in handler to a constants package as at least one of them (ErrRunIDNotValid) is referenced from two different packages (handler and engine tests)
…ternalCallsMetrics
jakobht
requested review from
Shaddoll,
neil-xie,
davidporter-id-au,
Groxx,
shijiesheng,
agautam478,
3vilhamster,
sankari165,
dkrotx,
taylanisikdemir and
demirkayaender
as code owners
taylanisikdemir
approved these changes
Feb 23, 2024
3vilhamster
reviewed
Feb 26, 2024
Pull Request Test Coverage Report for Build 018deeed-f764-410d-be86-f1b4e7b1312fDetails
💛 - Coveralls |
davidporter-id-au
approved these changes
Feb 27, 2024
|
+1 on David's point. Might be better to introduce a dry run mode and control it with dynamic config. |
3vilhamster
approved these changes
Feb 28, 2024
| "ratelimitTypeUserPerID" | ||
| }} | ||
|
|
||
| {{ $workflowID := ( get ( get $ratelimitTypeMap $method.Name ) "workflowID" ) }} |
There was a problem hiding this comment.
nit: call the fields with Field suffix:
$workflowIDField
So it is easier to read the code.
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.
What changed?
Added a wrapper around the history handler which logs rate limit metrics the external calls we want to rate limit with the workflow specific rate limiter.
Why?
We want to investigate the rate limiting for all external calls that can cause hot shards, before we deploy.
How did you test it?
Unit tests and local tests
Potential risks
Release notes
Documentation Changes