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.

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

Removed deprecated metrics from documentation (#7740) #7755

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion hack/docs/metrics_gen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@ func main() {
allMetrics = lo.UniqBy(allMetrics, func(m metricInfo) string {
return fmt.Sprintf("%s/%s/%s", m.namespace, m.subsystem, m.name)
})

// remove metrics deprecated
allMetrics = lo.Reject(allMetrics, func(m metricInfo, _ int) bool {
return strings.Contains(strings.ToLower(m.help), "deprecated")
})
// Drop some metrics
for _, subsystem := range []string{"rest_client", "certwatcher_read", "controller_runtime_webhook"} {
allMetrics = lo.Reject(allMetrics, func(m metricInfo, _ int) bool {
Expand Down
28 changes: 0 additions & 28 deletions website/content/en/docs/reference/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,16 +155,6 @@ Pod state is the current state of pods. This metric can be used several ways as
The time from pod creation until the pod is running.
- Stability Level: STABLE

## Termination Metrics
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We auto-gen all of this documentation with make docgen -- if you were to run that, I think it would remove your changes -- I think you need to make a change to the metrics_gen script file to get this to work

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I will check it


### `operator_termination_duration_seconds`
The amount of time taken by an object to terminate completely.
- Stability Level: DEPRECATED

### `operator_termination_current_time_seconds`
The current amount of time in seconds that an object has been in terminating state.
- Stability Level: DEPRECATED

## Voluntary Disruption Metrics

### `karpenter_voluntary_disruption_queue_failures_total`
Expand Down Expand Up @@ -391,24 +381,6 @@ Current depth of workqueue
Total number of adds handled by workqueue
- Stability Level: STABLE

## Status Condition Metrics

### `operator_status_condition_transitions_total`
The count of transitions of a given object, type and status.
- Stability Level: DEPRECATED

### `operator_status_condition_transition_seconds`
The amount of time a condition was in a given state before transitioning. e.g. Alarm := P99(Updated=False) > 5 minutes
- Stability Level: DEPRECATED

### `operator_status_condition_current_status_seconds`
The current amount of time in seconds that a status condition has been in a specific state. Alarm := P99(Updated=Unknown) > 5 minutes
- Stability Level: DEPRECATED

### `operator_status_condition_count`
The number of an condition for a given object, type and status. e.g. Alarm := Available=False > 0
- Stability Level: DEPRECATED

## Client Go Metrics

### `client_go_request_total`
Expand Down
Loading