configclassqueries.go

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package main

type ClassQueries map[string]*ClassQuery
type CompoundClassQueries map[string]*CompoundClassQuery
type GroupClassQueries map[string]*GroupClassQuery

// BuiltinQueries BuiltinQueries queries named and point to a function to execute
type BuiltinQueries map[string]func(chan []MetricDefinition)

type AllQueries struct {
	ClassQueries         ClassQueries         `yaml:"class_queries"`
	CompoundClassQueries CompoundClassQueries `yaml:"compound_queries"`
	GroupClassQueries    GroupClassQueries    `yaml:"group_class_queries"`
}

type GroupClassQuery struct {
	Name         string         `mapstructure:"name" yaml:"name"`
	Unit         string         `mapstructure:"unit" yaml:"unit"`
	Type         string         `mapstructure:"type" yaml:"type"`
	Help         string         `mapstructure:"help" yaml:"help"`
	Queries      []ClassQuery   `string:"queries"`
	StaticLabels []StaticLabels `string:"staticlabels"`
}

// ClassQuery define the structure of configured queries
type ClassQuery struct {
	ClassName      string         `mapstructure:"class_name" yaml:"class_name"`
	QueryParameter string         `mapstructure:"query_parameter" yaml:"query_parameter"`
	Metrics        []ConfigMetric `string:"metrics"`
	Labels         []ConfigLabels `string:"labels"`
	StaticLabels   []StaticLabels `string:"staticlabels"`
}

// ConfigMetric define the configuration of metric
type ConfigMetric struct {
	Name                string             `mapstructure:"name" yaml:"name"`
	ValueName           string             `mapstructure:"value_name" yaml:"value_name"`
	ValueCalculation    string             `mapstructure:"value_calculation" yaml:"value_calculation"`
	Unit                string             `mapstructure:"unit" yaml:"unit"`
	Type                string             `mapstructure:"type" yaml:"type"`
	Help                string             `mapstructure:"help" yaml:"help"`
	ValueTransform      map[string]float64 `mapstructure:"value_transform" yaml:"value_transform"`
	ValueRegexTransform string             `mapstructure:"value_regex_transformation" yaml:"value_regex_transformation"`
}

// ConfigLabels define the configuration of label to parse
type ConfigLabels struct {
	PropertyName string `mapstructure:"property_name" yaml:"property_name"`
	Regex        string `mapstructure:"regex" yaml:"regex"`
}

type StaticLabels struct {
	Key   string `mapstructure:"key" yaml:"key"`
	Value string `mapstructure:"value" yaml:"value"`
}

// CompoundClassQuery define aggregation by common label, typical used for counting
type CompoundClassQuery struct {
	ClassNames []ClassLabelMapping `string:"classnames"`
	Metrics    []ConfigMetric      `string:"metrics"`
	LabelName  string              `mapstructure:"labelname"`
}

type ClassLabelMapping struct {
	Class          string `mapstructure:"class_name" yaml:"class_name"`
	Label          string `mapstructure:"label_value" yaml:"label_value"`
	QueryParameter string `mapstructure:"query_parameter" yaml:"query_parameter"`
	ValueName      string `mapstructure:"value_name" yaml:"value_name"`
}