feat: circuit status now contains a rolling window #34
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
helio-frota
approved these changes
Mar 9, 2017
lib/status.js
Outdated
| } | ||
|
|
||
| const stats = () => ({ |
There was a problem hiding this comment.
cache hits/misses will be part of stats [right?]
There was a problem hiding this comment.
I will merge from master before pushing my changes. There will be conflicts in this file, but I will deal with them.
1 similar comment
The rolling stats window is configurable in both total time sampled, and
how many snapshots, or buckets, within that time frame.
The new options that can be applied to a circuit breaker are
`rollingCountTimeout` and `rollingCountBuckets`, which default to 10000
and 10, respectively. So by default, the window is a statistical view
over the last 10 seconds, consisting of 10 one second snapshots.
The current circuit breaker status api has not been modified directly,
however the expected results are different. For example, you can still
do this:
```js
console.log(`Failure count: ${circuit.status.failures}`);
```
But that count will consist only of the number of failures within the
current snapshot.
To obtain stats for the entire window, use the `window` property.
```js
const stats = circuit.status.window;
```
This will give you an array containing the statistical sampling for the
entire window. So, given the defaults noted above, by default this will
be a ten element array, with each element containing an object with
sample data that looks something like this:
```js
{
failures: 11,
fallbacks: 9,
successes: 3491,
rejects: 2,
fires: 3493,
timeouts: 0,
start: 1488999002013
}
```
Users can add a listener to a circuit's status object, which gets called with the most recent status each time a new snapshot is created. Allows users to maintain cumulative stats if they want to.
lholmquist
force-pushed
the
rolling-stats
branch
from
972b830
to
1434c0f
Compare
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.
This is an ongoing PR, do not merge yet
The rolling stats window is configurable in both total time sampled, and
how many snapshots, or buckets, within that time frame.
The new options that can be applied to a circuit breaker are
rollingCountTimeoutandrollingCountBuckets, which default to 10000and 10, respectively. So by default, the window is a statistical view
over the last 10 seconds, consisting of 10 one second snapshots.
The current circuit breaker status api has not been modified directly,
however the expected results are different. For example, you can still
do this:
But that count will consist only of the number of failures within the
current snapshot.
To obtain stats for the entire window, use the
windowproperty.This will give you an array containing the statistical sampling for the
entire window. So, given the defaults noted above, by default this will
be a ten element array, with each element containing an object with
sample data that looks something like this: