Skip to content

Commit

Permalink
Improve description of MaxAge in summary docs (#864)
Browse files Browse the repository at this point in the history
* Improve description of MaxAge in summary docs

Signed-off-by: Dean Coakley <[email protected]>
  • Loading branch information
Dean-Coakley authored May 4, 2021
1 parent 5486764 commit 3998a67
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion prometheus/summary.go
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

0 comments on commit 3998a67

Please sign in to comment.