Skip to content

Commit b410166

Browse files
committed
replace kube_crd with kube_customresource in docs
Signed-off-by: Mario Constanti <[email protected]>
1 parent 7130bd0 commit b410166

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/customresourcestate-metrics.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ spec:
117117
Produces the metric:
118118

119119
```prometheus
120-
kube_crd_uptime{group="myteam.io", kind="Foo", version="v1"} 43.21
120+
kube_customresource_uptime{customresource_group="myteam.io", kind="Foo", version="v1"} 43.21
121121
```
122122

123123
#### Multiple Metrics/Kitchen Sink
@@ -169,8 +169,8 @@ spec:
169169
Produces the following metrics:
170170

171171
```prometheus
172-
kube_crd_ready_count{group="myteam.io", kind="Foo", version="v1", active="1",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-a"} 2
173-
kube_crd_ready_count{group="myteam.io", kind="Foo", version="v1", active="3",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-b"} 4
172+
kube_customresource_ready_count{customresource_group="myteam.io", kind="Foo", version="v1", active="1",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-a"} 2
173+
kube_customresource_ready_count{customresource_group="myteam.io", kind="Foo", version="v1", active="3",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-b"} 4
174174
```
175175

176176
### Metric types
@@ -205,7 +205,7 @@ spec:
205205
Produces the metric:
206206

207207
```prometheus
208-
kube_crd_uptime{group="myteam.io", kind="Foo", version="v1"} 43.21
208+
kube_customresource_uptime{customresource_group="myteam.io", kind="Foo", version="v1"} 43.21
209209
```
210210

211211
#### StateSet
@@ -237,9 +237,9 @@ The value will be 1, if the value matches the one in list.
237237
Produces the metric:
238238

239239
```prometheus
240-
kube_crd_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Pending"} 1
241-
kube_crd_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Bar"} 0
242-
kube_crd_status_phase{group="myteam.io", kind="Foo", version="v1", phase="Baz"} 0
240+
kube_customresource_status_phase{customresource_group="myteam.io", kind="Foo", version="v1", phase="Pending"} 1
241+
kube_customresource_status_phase{customresource_group="myteam.io", kind="Foo", version="v1", phase="Bar"} 0
242+
kube_customresource_status_phase{customresource_group="myteam.io", kind="Foo", version="v1", phase="Baz"} 0
243243
```
244244

245245
#### Info
@@ -269,7 +269,7 @@ spec:
269269
Produces the metric:
270270

271271
```prometheus
272-
kube_crd_version{group="myteam.io", kind="Foo", version="v1", version="v1.2.3"} 1
272+
kube_customresource_version{customresource_group="myteam.io", kind="Foo", version="v1", version="v1.2.3"} 1
273273
```
274274

275275
### Naming
@@ -291,7 +291,7 @@ spec:
291291

292292
Produces:
293293
```prometheus
294-
myteam_foos_uptime{group="myteam.io", kind="Foo", version="v1"} 43.21
294+
myteam_foos_uptime{customresource_group="myteam.io", kind="Foo", version="v1"} 43.21
295295
```
296296

297297
To omit namespace and/or subsystem altogether, set them to the empty string:

docs/verticalpodautoscaler-metrics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ spec:
3030
gauge:
3131
path: [metadata, annotations]
3232
# This will output the following metric:
33-
# HELP kube_crd_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations Kubernetes annotations converted to Prometheus labels.
34-
# TYPE kube_crd_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations gauge
35-
# kube_crd_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations{namespace="default",target_api_version="autoscaling.k8s.io/v1",target_kind="Deployment",target_name="hamster",verticalpodautoscaler="hamster-vpa"} 123
33+
# HELP kube_customresource_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations Kubernetes annotations converted to Prometheus labels.
34+
# TYPE kube_customresource_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations gauge
35+
# kube_customresource_autoscaling_k8s_io_v1_VerticalPodAutoscaler_annotations{namespace="default",target_api_version="autoscaling.k8s.io/v1",target_kind="Deployment",target_name="hamster",verticalpodautoscaler="hamster-vpa"} 123
3636
```
3737
PS. The above configuration was tested on [this](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/examples/hamster.yaml) VPA configuration, with an added annotation (`foo: 123`).
3838
***

0 commit comments

Comments
 (0)