Merge pull request #572 from prometheus/beorn7/deprecation

Clarify deprecation of `DefObjectives`
This commit is contained in:
Björn Rabenstein 2019-05-08 13:54:16 +02:00 committed by GitHub
commit b0f4d8e1d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions

View File

@ -127,9 +127,10 @@ type SummaryOpts struct {
// its zero value (i.e. nil). To create a Summary without Objectives, // its zero value (i.e. nil). To create a Summary without Objectives,
// set it to an empty map (i.e. map[float64]float64{}). // set it to an empty map (i.e. map[float64]float64{}).
// //
// Deprecated: Note that the current value of DefObjectives is // Note that the current value of DefObjectives is deprecated. It will
// deprecated. It will be replaced by an empty map in v0.10 of the // be replaced by an empty map in v0.10 of the library. Please
// library. Please explicitly set Objectives to the desired value. // explicitly set Objectives to the desired value to avoid problems
// during the transition.
Objectives map[float64]float64 Objectives map[float64]float64
// MaxAge defines the duration for which an observation stays relevant // MaxAge defines the duration for which an observation stays relevant