doc: generate metrics should include metrics

Created by builtin plugins: Aggregator, Max, and MetricAgent

fix: resource_headroom templates should use `api` prefixed query

cmd/tools/template/template.go

@@ -215,13 +215,13 @@ func flattenCounters(n *y3.Node, metrics *[]Metric, parents []string) {
 			flattenCounters(c, metrics, parents)
 		}
 	case "!!str":
-		*metrics = append(*metrics, newZapiMetric(n, parents))
+		*metrics = append(*metrics, newMetric(n, parents))
 	}
 }
 
 var sigilReplacer = strings.NewReplacer("^", "", "- ", "")
 
-func newZapiMetric(n *y3.Node, parents []string) Metric {
+func newMetric(n *y3.Node, parents []string) Metric {
 	// separate left and right and remove all sigils
 	text := n.Value
 	noSigils := sigilReplacer.Replace(text)

cmd/tools/template/template_test.go

@@ -352,6 +352,14 @@ func (m Metric) pathString() string {
 	return strings.Join(m.parents, "/") + "/" + m.left
 }
 
+func TestQueryPrefix(t *testing.T) {
+	visitTemplates(t, func(path string, model Model) {
+		if !strings.HasPrefix(model.Query, "api/") {
+			t.Errorf("query should be prefixed with api/, got=%s path=[%s]", model.Query, shortPath(path))
+		}
+	}, []string{"rest", "restperf"}...)
+}
+
 // Tests that keys and metrics are sorted in the following order:
 // - double hats (alphabetically)
 // - single hats (alphabetically)

conf/restperf/9.12.0/resource_headroom_aggr.yaml

@@ -1,5 +1,5 @@
 name:                     HeadroomAggr
-query:                    /api/cluster/counter/tables/headroom_aggregate
+query:                    api/cluster/counter/tables/headroom_aggregate
 object:                   headroom_aggr
 
 counters:

conf/restperf/9.12.0/resource_headroom_cpu.yaml

@@ -1,5 +1,5 @@
 name:                     HeadroomCPU
-query:                    /api/cluster/counter/tables/headroom_cpu
+query:                    api/cluster/counter/tables/headroom_cpu
 object:                   headroom_cpu
 
 counters: