Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos in customresourcestate-metrics doc #1870

Merged
merged 3 commits into from
Oct 27, 2022
Merged

Fix typos in customresourcestate-metrics doc #1870

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c6fff1
Fix typos
timp87 Oct 26, 2022
1ea0ba8
One more typo fix
timp87 Oct 26, 2022
aba1302
Clarify valueFrom comment
timp87 Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/customresourcestate-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ spec:
# label values can be resolved specific to this path
labelsFromPath:
active: [active]
# The actual field to use as metric value. Should be a number.
value: [ready]
# The actual field to use as metric value. Should be a number, boolean or RFC3339 timestamp string.
valueFrom: [ready]
commonLabels:
custom_metric: "yes"
labelsFromPath:
Expand All @@ -168,8 +168,8 @@ spec:
Produces the following metrics:

```prometheus
kube_crd_active_count{group="myteam.io", kind="Foo", version="v1", active="1",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-a"} 1
kube_crd_active_count{group="myteam.io", kind="Foo", version="v1", active="3",custom_metric="yes",foo="bar",name="foo",bar="baz",qux="quxx",type="type-b"} 3
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
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
```

### Metric types
Expand Down