Skip to content

Commit 3998a67

Browse files
authored
Improve description of MaxAge in summary docs (#864)
* Improve description of MaxAge in summary docs Signed-off-by: Dean Coakley <[email protected]>
1 parent 5486764 commit 3998a67

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

prometheus/summary.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,9 @@ type SummaryOpts struct {
121121
Objectives map[float64]float64
122122

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

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

0 commit comments

Comments
 (0)