This repository has been archived by the owner on May 3, 2024. It is now read-only.
feat(circuitBreaker): configurable event loop delay percentile #1024
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
|
Size Change: 0 B Total Size: 667 kB ℹ️ View Unchanged
|
JAdshead
reviewed
Jun 15, 2023
src/server/utils/onModuleLoad.js
Outdated
| @@ -129,6 +130,7 @@ export default function onModuleLoad({ | |||
| setConfigureRequestLog(configureRequestLog); | |||
| setCreateSsrFetch(createSsrFetch); | |||
| setEventLoopDelayThreshold(eventLoopDelayThreshold); | |||
| setEventLoopDelayPercentile(eventLoopDelayPercentile); | |||
There was a problem hiding this comment.
we want to avoid calling with undefined, the same goes for above
Suggested change
| setEventLoopDelayPercentile(eventLoopDelayPercentile); | |
| if(eventLoopDelayPercentile) { setEventLoopDelayPercentile(eventLoopDelayPercentile); } |
JAdshead
reviewed
Jun 15, 2023
| @@ -22,12 +22,24 @@ import { registerCircuitBreaker } from '../metrics/circuit-breaker'; | |||
|
|
|||
| const { rootModuleName } = getServerStateConfig(); | |||
| let eventLoopDelayThreshold = 250; | |||
| let eventLoopDelayPercentile = 100; | |||
|
|
|||
| export const setEventLoopDelayThreshold = (n) => { | |||
There was a problem hiding this comment.
maybe set to default when no value given
Suggested change
| export const setEventLoopDelayThreshold = (n) => { | |
| export const setEventLoopDelayThreshold = (n=eventLoopDelayThreshold) => { |
There was a problem hiding this comment.
This is not equivalent functionally as the current implementation will coerce a non-number into the default
JAdshead
reviewed
Jun 15, 2023
| if (process.env.NODE_ENV === 'development') return; | ||
| // Return if root module is not loaded, as that is where threshold is configured | ||
| if (!getModule(rootModuleName)) return; | ||
| // Get event loop delay in milliseconds (from nanoseconds) | ||
| const maxEventLoopDelay = eventLoopDelayHistogram.max / 1e6; | ||
| const eventLoopDelay = eventLoopDelayHistogram.percentile(eventLoopDelayPercentile) / 1e6; |
There was a problem hiding this comment.
can this handle any number ?
There was a problem hiding this comment.
Just integers 1-100, as validated
dogpatch626
reviewed
Jun 15, 2023
| }; | ||
|
|
||
| export const setEventLoopDelayPercentile = (n) => { | ||
| if (typeof n !== 'undefined' && (n !== Number.parseInt(n, 10) || n < 1 || n > 100)) { |
There was a problem hiding this comment.
why not just
if (!n && (n !== Number.parseInt(n, 10) || n < 1 || n > 100)) {
Matthew-Mallimo
approved these changes
Jun 19, 2023
JAdshead
approved these changes
Jun 19, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
New configuration option for circuit breakers event loop delay check
Motivation and Context
Currently the circuit breaker is based on max event loop delay, which is not ideal as it indicates an outlier rather than a trend. p(99) can be significantly lower than p(100) (max). The default is left at 100 to avoid a breaking change to behavior. This change required the addition of an interval upon which to reset the histogram since it biases lower over time.
How Has This Been Tested?
Unit test + running locally while monitoring circuit breaker metrics and load testing with autocanon
Types of Changes
Checklist:
a maintenancemain branch.What is the Impact to Developers Using One App?