statsd_exporter/pkg/mapper/mapper_defaults.go

// Copyright 2020 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package mapper

import "time"

type MapperConfigDefaults struct {
	ObserverType        ObserverType     `yaml:"observer_type"`
	MatchType           MatchType        `yaml:"match_type"`
	GlobDisableOrdering bool             `yaml:"glob_disable_ordering"`
	Ttl                 time.Duration    `yaml:"ttl"`
	SummaryOptions      SummaryOptions   `yaml:"summary_options"`
	HistogramOptions    HistogramOptions `yaml:"histogram_options"`
}

// mapperConfigDefaultsAlias is used to unmarshal the yaml config into mapperConfigDefaults and allows deprecated fields
type mapperConfigDefaultsAlias struct {
	ObserverType        ObserverType      `yaml:"observer_type"`
	TimerType           ObserverType      `yaml:"timer_type,omitempty"` // DEPRECATED - field only present to preserve backwards compatibility in configs
	Buckets             []float64         `yaml:"buckets"`              // DEPRECATED - field only present to preserve backwards compatibility in configs
	Quantiles           []MetricObjective `yaml:"quantiles"`            // DEPRECATED - field only present to preserve backwards compatibility in configs
	MatchType           MatchType         `yaml:"match_type"`
	GlobDisableOrdering bool              `yaml:"glob_disable_ordering"`
	Ttl                 time.Duration     `yaml:"ttl"`
	SummaryOptions      SummaryOptions    `yaml:"summary_options"`
	HistogramOptions    HistogramOptions  `yaml:"histogram_options"`
}

// UnmarshalYAML is a custom unmarshal function to allow use of deprecated config keys
// observer_type will override timer_type
func (d *MapperConfigDefaults) UnmarshalYAML(unmarshal func(interface{}) error) error {
	var tmp mapperConfigDefaultsAlias
	if err := unmarshal(&tmp); err != nil {
		return err
	}

	// Copy defaults
	d.ObserverType = tmp.ObserverType
	d.MatchType = tmp.MatchType
	d.GlobDisableOrdering = tmp.GlobDisableOrdering
	d.Ttl = tmp.Ttl
	d.SummaryOptions = tmp.SummaryOptions
	d.HistogramOptions = tmp.HistogramOptions

	// Use deprecated TimerType if necessary
	if tmp.ObserverType == "" {
		d.ObserverType = tmp.TimerType
	}

	// Use deprecated quantiles if necessary
	if len(tmp.SummaryOptions.Quantiles) == 0 && len(tmp.Quantiles) > 0 {
		d.SummaryOptions = SummaryOptions{Quantiles: tmp.Quantiles}
	}

	// Use deprecated buckets if necessary
	if len(tmp.HistogramOptions.Buckets) == 0 && len(tmp.Buckets) > 0 {
		d.HistogramOptions = HistogramOptions{Buckets: tmp.Buckets}
	}

	return nil
}