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

chore: Add some minor grammatical fixes to metrics analyzer #567

Merged
merged 1 commit into from
Oct 15, 2024
Merged

chore: Add some minor grammatical fixes to metrics analyzer #567

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/source/analyze/node-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: Kubernetes Node Metrics
description: Analyzing node metrics collected by the kubelet
---

The `nodeMetrics` analyzer is available to analyze [node metrics](https://kubernetes.io/docs/reference/instrumentation/node-metrics/) data collected by `kubelet` and served via kubernetes API server. The metrics are collected by the [nodeMetrics collector](/collect/node-metrics/). The analyzer can be used in support bundles or preflights that need to report check such as `pvc` usage capacity violations.
The `nodeMetrics` analyzer is available to analyze [node metrics](https://kubernetes.io/docs/reference/instrumentation/node-metrics/) data collected by `kubelet` and served via kubernetes API server. The metrics are collected by the [nodeMetrics collector](/collect/node-metrics/). The analyzer can be used in support bundles or preflights that need to report on checks such as `pvc` usage capacity violations.

This analyzer's outcome `when` clause compares the condition specified with the resources present such as a `pvc`.
This analyzer's `when` outcome clause compares the condition specified with the resources present such as a `pvc`.

This analyzer also supports a `filters` property. If provided, the resources analyzed are filtered to any resource that matches the filters specified.
This analyzer also supports a `filters` property. If provided, the resources analyzed are filtered to any resource that matches the filters specified. If no filters are specified, all collected metrics are inspected by the analyzer.

## Available Filters

Expand Down Expand Up @@ -43,7 +43,7 @@ kind: Preflight
spec:
analyzers:
- nodeMetrics:
checkName: Check for pvc space usage is less than 80% in the entire cluster
checkName: Check for PVCs using more than 80% storage space in the entire cluster
outcomes:
- fail:
when: "pvcUsedPercentage >= 80"
Expand All @@ -60,7 +60,7 @@ kind: Preflight
spec:
analyzers:
- nodeMetrics:
checkName: Check minio pvc space usage is less than 80%
checkName: Check if minio pvc storage usage is less than 80%
filters:
pvc:
nameRegex: "minio-data-ha-minio.*"
Expand Down