Skip to content
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

Jump to bottom

Improve description of MaxAge in summary docs #864

Merged
merged 2 commits into from
May 4, 2021
Merged

Improve description of MaxAge in summary docs #864

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a814c81
Improve description of MaxAge in summary docs
Dean-Coakley May 4, 2021
075cb81
Remove trailing whitespace
Dean-Coakley May 4, 2021
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: 3 additions & 1 deletion prometheus/summary.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@ type SummaryOpts struct {
Objectives map[float64]float64

// MaxAge defines the duration for which an observation stays relevant
// for the summary. Must be positive. The default value is DefMaxAge.
// for the summary. Only applies to pre-calculated quantiles, does not
// apply to _sum and _count. Must be positive. The default value is
// DefMaxAge.
MaxAge time.Duration

// AgeBuckets is the number of buckets used to exclude observations that
Expand Down