config.go

//  Copyright (c) 2018 Cisco and/or its affiliates.
//
//  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 telemetry

import "time"

const (
	// default period between updates
	defaultUpdatePeriod = time.Second * 30
	// minimum period between updates
	minimumUpdatePeriod = time.Second * 1
)

// Config file representation for telemetry plugin
type Config struct {
	// Custom polling interval, default value is 30s
	PollingInterval time.Duration `json:"polling-interval"`
	// Allows to disable plugin
	Disabled bool `json:"disabled"`
	// Allows to export prometheus in telemetry plugin
	PrometheusDisabled bool `json:"prometheus-disabled"`
	// Skip collecting some of the metrics:
	// 	runtime, memory, buffers, nodes, interfaces
	Skipped []string `json:"skipped"`
}

var DefaultConfig = func() *Config {
	return &Config{
		PollingInterval: defaultUpdatePeriod,
	}
}

// loadConfig returns telemetry plugin file configuration if exists
func (p *Plugin) loadConfig() (*Config, error) {
	cfg := &Config{}
	if DefaultConfig != nil {
		cfg = DefaultConfig()
	}

	found, err := p.Cfg.LoadValue(cfg)
	if err != nil {
		return nil, err
	}

	if !found {
		p.Log.Debugf("Telemetry config not found. Using default config: %+v", cfg)
	} else {
		p.Log.Debugf("Telemetry config found: %+v", cfg)
	}

	return cfg, nil
}