doc: generate metrics should include metrics created by builtin (#2413

)

plugins created by builtin plugins: Aggregator, Max, and MetricAgent

fix: resource_headroom templates should use `api` prefixed query

cmd/poller/plugin/aggregator/aggregator.go

@@ -306,3 +306,13 @@ func (a *Aggregator) NewLabels() []string {
 
 	return newLabelNames
 }
+
+// NewMetrics returns the new metrics the receiver creates
+func (a *Aggregator) NewMetrics() []plugin.DerivedMetric {
+	var derivedMetrics []plugin.DerivedMetric
+	for _, r := range a.rules {
+		derivedMetrics = append(derivedMetrics, plugin.DerivedMetric{Name: r.label, Source: r.object})
+	}
+
+	return derivedMetrics
+}

cmd/poller/plugin/max/max.go

@@ -20,7 +20,7 @@ type Max struct {
 	rules []*rule
 }
 
-func New(p *plugin.AbstractPlugin) plugin.Plugin {
+func New(p *plugin.AbstractPlugin) *Max {
 	return &Max{AbstractPlugin: p}
 }
 
@@ -239,3 +239,13 @@ func (m *Max) Run(dataMap map[string]*matrix.Matrix) ([]*matrix.Matrix, error) {
 
 	return matricesArray, nil
 }
+
+// NewMetrics returns the new metrics the receiver creates
+func (m *Max) NewMetrics() []plugin.DerivedMetric {
+	var derivedMetrics []plugin.DerivedMetric
+	for _, r := range m.rules {
+		derivedMetrics = append(derivedMetrics, plugin.DerivedMetric{Name: r.object, Source: r.label, IsMax: true})
+	}
+
+	return derivedMetrics
+}

cmd/poller/plugin/metricagent/metric_agent.go

@@ -9,6 +9,7 @@ import (
 	"github.com/netapp/harvest/v2/pkg/errs"
 	"github.com/netapp/harvest/v2/pkg/matrix"
 	"strconv"
+	"strings"
 )
 
 type MetricAgent struct {
@@ -17,7 +18,7 @@ type MetricAgent struct {
 	computeMetricRules []computeMetricRule
 }
 
-func New(p *plugin.AbstractPlugin) plugin.Plugin {
+func New(p *plugin.AbstractPlugin) *MetricAgent {
 	return &MetricAgent{AbstractPlugin: p}
 }
 
@@ -144,3 +145,15 @@ func (a *MetricAgent) getMetric(m *matrix.Matrix, name string) *matrix.Metric {
 	}
 	return m.GetMetric(name)
 }
+
+// NewMetrics returns the new metrics the receiver creates
+func (a *MetricAgent) NewMetrics() []plugin.DerivedMetric {
+	var derivedMetrics []plugin.DerivedMetric
+	for _, rule := range a.computeMetricRules {
+		derivedMetrics = append(derivedMetrics, plugin.DerivedMetric{
+			Name:   rule.metric,
+			Source: strings.Join(rule.metricNames, ", "),
+		})
+	}
+	return derivedMetrics
+}

cmd/poller/plugin/plugin.go

@@ -173,3 +173,9 @@ func GetInterval(param *node.Node, defaultInterval time.Duration) float64 {
 	}
 	return defaultInterval.Seconds()
 }
+
+type DerivedMetric struct {
+	Name   string
+	Source string
+	IsMax  bool
+}