Skip to content

docs: clarify EWMA proxy timing #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Solaris-star wants to merge 1 commit into from
Closed

docs: clarify EWMA proxy timing #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions decor/speed.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ func (s *speedFormatter) Format(st fmt.State, verb rune) {
// EwmaSpeed exponential-weighted-moving-average based speed decorator.
// For this decorator to work correctly you have to measure each iteration's
// duration and pass it to one of the (*Bar).EwmaIncr... family methods.
//
// ProxyReader and ProxyWriter report each wrapped I/O operation as an iteration,
// so delays between calls are excluded. Use [AverageSpeed] when throughput
// should include idle time over the bar's complete lifetime.
func EwmaSpeed(unit any, format string, age float64, wcc ...WC) Decorator {
return MovingAverageSpeed(unit, format, NewThreadSafeMovingAverage(ewma.NewMovingAverage(age)), wcc...)
}
Expand Down