/*
Copyright 2020 The Kubernetes 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 main
import (
"bytes"
"fmt"
"os"
"sort"
"strings"
"text/template"
"time"
flag "github.com/spf13/pflag"
"gopkg.in/yaml.v2"
"k8s.io/component-base/metrics"
)
var (
GOROOT string = os.Getenv("GOROOT")
GOOS string = os.Getenv("GOOS")
KUBE_ROOT string = os.Getenv("KUBE_ROOT")
funcMap = template.FuncMap{
"ToLower": strings.ToLower,
}
)
const (
templ = `---
title: Kubernetes Metrics Reference
content_type: reference
auto_generated: true
description: >-
Details of the metric data that Kubernetes components export.
---
## Metrics (v{{.GeneratedVersion}})
This page details the metrics that different Kubernetes components export. You can query the metrics endpoint for these
components using an HTTP scrape, and fetch the current metrics data in Prometheus format.
### List of Stable Kubernetes Metrics
Name |
Stability Level |
Type |
Help |
Labels |
Const Labels |
Deprecated Version |
{{range $index, $metric := .StableMetrics}}
{{with $metric}}{{.BuildFQName}}{{end}} |
{{$metric.StabilityLevel}} |
{{$metric.Type}} |
{{$metric.Help}} |
{{if not $metric.Labels }} | {{else }}{{range $label := $metric.Labels}} {{$label}} {{end}} | {{end}}
{{if not $metric.ConstLabels }} | {{else }}{{range $key, $value := $metric.ConstLabels}} {{$key}}:{{$value}} {{end}} | {{end}}
{{if not $metric.DeprecatedVersion }} | {{else }}{{$metric.DeprecatedVersion}} | {{end}}
{{end}}
### List of Beta Kubernetes Metrics
Name |
Stability Level |
Type |
Help |
Labels |
Const Labels |
Deprecated Version |
{{range $index, $metric := .BetaMetrics}}
{{with $metric}}{{.BuildFQName}}{{end}} |
{{$metric.StabilityLevel}} |
{{$metric.Type}} |
{{$metric.Help}} |
{{if not $metric.Labels }} | {{else }}{{range $label := $metric.Labels}} {{$label}} {{end}} | {{end}}
{{if not $metric.ConstLabels }} | {{else }}{{range $key, $value := $metric.ConstLabels}} {{$key}}:{{$value}} {{end}} | {{end}}
{{if not $metric.DeprecatedVersion }} | {{else }}{{$metric.DeprecatedVersion}} | {{end}}
{{end}}
### List of Alpha Kubernetes Metrics
Name |
Stability Level |
Type |
Help |
Labels |
Const Labels |
Deprecated Version |
{{range $index, $metric := .AlphaMetrics}}
{{with $metric}}{{.BuildFQName}}{{end}} |
{{$metric.StabilityLevel}} |
{{$metric.Type}} |
{{$metric.Help}} |
{{if not $metric.Labels }} | {{else }}{{range $label := $metric.Labels}} {{$label}} {{end}} | {{end}}
{{if not $metric.ConstLabels }} | {{else }}{{range $key, $value := $metric.ConstLabels}} {{$key}}:{{$value}} {{end}} | {{end}}
{{if not $metric.DeprecatedVersion }} | {{else }}{{$metric.DeprecatedVersion}} | {{end}}
{{end}}
`
)
type templateData struct {
AlphaMetrics []metric
BetaMetrics []metric
StableMetrics []metric
GeneratedDate time.Time
GeneratedVersion string
}
func main() {
var major string
var minor string
flag.StringVar(&major, "major", "", "k8s major version")
flag.StringVar(&minor, "minor", "", "k8s minor version")
flag.Parse()
println(major, minor)
dat, err := os.ReadFile("test/instrumentation/documentation/documentation-list.yaml")
if err == nil {
var parsedMetrics []metric
err = yaml.Unmarshal(dat, &parsedMetrics)
if err != nil {
println("err", err)
}
sort.Sort(byFQName(parsedMetrics))
t := template.New("t").Funcs(funcMap)
t, err := t.Parse(templ)
if err != nil {
println("err", err)
}
var tpl bytes.Buffer
for i, m := range parsedMetrics {
m.Help = strings.Join(strings.Split(m.Help, "\n"), ", ")
_ = m.BuildFQName() // ignore golint error
parsedMetrics[i] = m
}
sortedMetrics := byStabilityLevel(parsedMetrics)
data := templateData{
AlphaMetrics: sortedMetrics["ALPHA"],
BetaMetrics: sortedMetrics["BETA"],
StableMetrics: sortedMetrics["STABLE"],
GeneratedDate: time.Now(),
GeneratedVersion: fmt.Sprintf("%v.%v", major, parseMinor(minor)),
}
err = t.Execute(&tpl, data)
if err != nil {
println("err", err)
}
fmt.Print(tpl.String())
} else {
fmt.Fprintf(os.Stderr, "%s\n", err)
}
}
type metric struct {
Name string `yaml:"name" json:"name"`
Subsystem string `yaml:"subsystem,omitempty" json:"subsystem,omitempty"`
Namespace string `yaml:"namespace,omitempty" json:"namespace,omitempty"`
Help string `yaml:"help,omitempty" json:"help,omitempty"`
Type string `yaml:"type,omitempty" json:"type,omitempty"`
DeprecatedVersion string `yaml:"deprecatedVersion,omitempty" json:"deprecatedVersion,omitempty"`
StabilityLevel string `yaml:"stabilityLevel,omitempty" json:"stabilityLevel,omitempty"`
Labels []string `yaml:"labels,omitempty" json:"labels,omitempty"`
Buckets []float64 `yaml:"buckets,omitempty" json:"buckets,omitempty"`
Objectives map[float64]float64 `yaml:"objectives,omitempty" json:"objectives,omitempty"`
AgeBuckets uint32 `yaml:"ageBuckets,omitempty" json:"ageBuckets,omitempty"`
BufCap uint32 `yaml:"bufCap,omitempty" json:"bufCap,omitempty"`
MaxAge int64 `yaml:"maxAge,omitempty" json:"maxAge,omitempty"`
ConstLabels map[string]string `yaml:"constLabels,omitempty" json:"constLabels,omitempty"`
}
func (m metric) BuildFQName() string {
return metrics.BuildFQName(m.Namespace, m.Subsystem, m.Name)
}
type byFQName []metric
func (ms byFQName) Len() int { return len(ms) }
func (ms byFQName) Less(i, j int) bool {
if ms[i].StabilityLevel < ms[j].StabilityLevel {
return true
} else if ms[i].StabilityLevel > ms[j].StabilityLevel {
return false
}
return ms[i].BuildFQName() < ms[j].BuildFQName()
}
func (ms byFQName) Swap(i, j int) {
ms[i], ms[j] = ms[j], ms[i]
}
func byStabilityLevel(ms []metric) map[string][]metric {
res := map[string][]metric{}
for _, m := range ms {
if _, ok := res[m.StabilityLevel]; !ok {
res[m.StabilityLevel] = []metric{}
}
res[m.StabilityLevel] = append(res[m.StabilityLevel], m)
}
return res
}
func parseMinor(m string) string {
return strings.Trim(m, `+`)
}