github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-21 10:51:29 +00:00
Code Issues Projects Releases Wiki Activity

make changes suggested by sig docs

Browse Source 
Change-Id: I793eea636e7a83da7f87b23a3aa4e7ddfaf42ec6
This commit is contained in:
Han Kang 2022-10-25 17:08:00 -04:00
parent 1e99f54bb6
commit fa2eb8e3ea
2 changed files with 1815 additions and 325 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
test/instrumentation/documentation/main.go
View File

@ -34,37 +34,46 @@ var (
GOROOT string = os.Getenv("GOROOT") GOROOT string = os.Getenv("GOROOT")
GOOS string = os.Getenv("GOOS") GOOS string = os.Getenv("GOOS")
KUBE_ROOT string = os.Getenv("KUBE_ROOT") KUBE_ROOT string = os.Getenv("KUBE_ROOT")
funcMap = template.FuncMap{
"ToLower": strings.ToLower,
}
) )
const ( const (
templ = `--- templ = `---
title: Kubernetes Metrics title: Kubernetes Metrics Reference
content_type: instrumentation content_type: reference
description: >-
Details of the metric data that Kubernetes components export.
--- ---
## Metrics ## Metrics (auto-generated {{.GeneratedDate.Format "2006 Jan 02"}})
These are the metrics which are exported in Kubernetes components (i.e. kube-apiserver, scheduler, kube-controller-manager, kube-proxy, cloud-controller-manager). 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.
(auto-generated {{.GeneratedDate.Format "2006 Jan 02"}})
### List of Kubernetes Metrics ### List of Kubernetes Metrics
<table class="table"> <table class="table" caption="This is the list of metrics emitted from core Kubernetes components">
<thead> <thead>
<tr> <tr>
<td width="20%">Name</td> <th class="metric_name">Name</th>
<td width="10%">Stability Level</td> <th class="metric_stability_level">Stability Level</th>
<td width="13%">Type</td> <th class="metric_type">Type</th>
<td width="27%">Help</td> <th class="metric_help">Help</th>
<td width="20%">Labels</td> <th class="metric_labels">Labels</th>
<td width="10%">Const Labels</td> <th class="metric_const_labels">Const Labels</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
{{range $index, $metric := .Metrics}}<tr><td>{{with $metric}}{{.BuildFQName}}{{end}}</td><td>{{$metric.StabilityLevel}}</td><td>{{$metric.Type}}</td><td>{{$metric.Help}}</td>{{if not $metric.Labels }}<td>None</td>{{else }}<td>{{range $label := $metric.Labels}}<div>{{$label}}</div>{{end}}</td>{{end}}{{if not $metric.ConstLabels }}<td>None</td>{{else }}<td>{{$metric.ConstLabels}}</td>{{end}}</tr> {{range $index, $metric := .Metrics}}
{{end}} <tr class="metric"><td class="metric_name">{{with $metric}}{{.BuildFQName}}{{end}}</td>
<td class="metric_stability_level" data-stability="{{$metric.StabilityLevel | ToLower}}">{{$metric.StabilityLevel}}</td>
<td class="metric_type" data-type="{{$metric.Type | ToLower}}">{{$metric.Type}}</td>
<td class="metric_description">{{$metric.Help}}</td>
{{if not $metric.Labels }}<td class="metric_labels_varying">None</td>{{else }}<td class="metric_labels_varying">{{range $label := $metric.Labels}}<div class="metric_label">{{$label}}</div>{{end}}</td>{{end}}
{{if not $metric.ConstLabels }}<td class="metric_labels_constant">None</td>{{else }}<td class="metric_labels_constant">{{$metric.ConstLabels}}</td>{{end}}</tr>{{end}}
</tbody> </tbody>
</table> </table>
` `
@ -84,7 +93,7 @@ func main() {
println("err", err) println("err", err)
} }
sort.Sort(byFQName(metrics)) sort.Sort(byFQName(metrics))
t := template.New("t") t := template.New("t").Funcs(funcMap)
t, err := t.Parse(templ) t, err := t.Parse(templ)
if err != nil { if err != nil {
println("err", err) println("err", err)

2099
test/instrumentation/testdata/documentation.md vendored
View File

File diff suppressed because it is too large Load Diff