Skip to content

Commit da3df97

Browse files
committed
docs: fix Upjet metric names across all versions
Correct CLI-related metrics from upjet_resource_* to upjet_terraform_* prefix and add the missing upjet_resource_deletion_seconds metric to the metrics reference table. Signed-off-by: Ashwin Rana <ashwin.rana@upbound.io>
1 parent b8b927a commit da3df97

File tree

5 files changed

+30
-25
lines changed

5 files changed

+30
-25
lines changed

content/master/guides/metrics.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,12 @@ These metrics are only emitted by Upjet-based providers (such as [provider-upjet
218218
| --- | --- |
219219
| {{<hover label="upjet_resource_ext_api_duration" line="1">}}upjet_resource_ext_api_duration{{</hover>}} | Measures in seconds how long it takes a Cloud SDK call to complete |
220220
| {{<hover label="upjet_resource_external_api_calls_total" line="2">}}upjet_resource_external_api_calls_total{{</hover>}} | The number of external API calls to cloud providers, with labels describing the endpoints and resources |
221-
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="3">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
222-
| {{<hover label="upjet_resource_ttr" line="4">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
223-
| {{<hover label="upjet_resource_cli_duration" line="5">}}upjet_resource_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
224-
| {{<hover label="upjet_resource_active_cli_invocations" line="6">}}upjet_resource_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
225-
| {{<hover label="upjet_resource_running_processes" line="7">}}upjet_resource_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
221+
| {{<hover label="upjet_resource_deletion_seconds" line="3">}}upjet_resource_deletion_seconds{{</hover>}} | Measures in seconds how long it takes for a resource to be deleted |
222+
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="4">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
223+
| {{<hover label="upjet_resource_ttr" line="5">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
224+
| {{<hover label="upjet_terraform_cli_duration" line="6">}}upjet_terraform_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
225+
| {{<hover label="upjet_terraform_active_cli_invocations" line="7">}}upjet_terraform_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
226+
| {{<hover label="upjet_terraform_running_processes" line="8">}}upjet_terraform_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
226227
{{</table >}}
227228

228229
## Controller-runtime and Kubernetes client metrics

content/v1.20/guides/metrics.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,12 @@ These metrics are only emitted by Upjet-based providers (such as [provider-upjet
7575
| --- | --- |
7676
| {{<hover label="upjet_resource_ext_api_duration" line="1">}}upjet_resource_ext_api_duration{{</hover>}} | Measures in seconds how long it takes a Cloud SDK call to complete |
7777
| {{<hover label="upjet_resource_external_api_calls_total" line="2">}}upjet_resource_external_api_calls_total{{</hover>}} | The number of external API calls to cloud providers, with labels describing the endpoints and resources |
78-
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="3">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
79-
| {{<hover label="upjet_resource_ttr" line="4">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
80-
| {{<hover label="upjet_resource_cli_duration" line="5">}}upjet_resource_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
81-
| {{<hover label="upjet_resource_active_cli_invocations" line="6">}}upjet_resource_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
82-
| {{<hover label="upjet_resource_running_processes" line="7">}}upjet_resource_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
78+
| {{<hover label="upjet_resource_deletion_seconds" line="3">}}upjet_resource_deletion_seconds{{</hover>}} | Measures in seconds how long it takes for a resource to be deleted |
79+
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="4">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
80+
| {{<hover label="upjet_resource_ttr" line="5">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
81+
| {{<hover label="upjet_terraform_cli_duration" line="6">}}upjet_terraform_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
82+
| {{<hover label="upjet_terraform_active_cli_invocations" line="7">}}upjet_terraform_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
83+
| {{<hover label="upjet_terraform_running_processes" line="8">}}upjet_terraform_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
8384
{{</table >}}
8485

8586
## Controller-runtime and Kubernetes client metrics

content/v2.0/guides/metrics.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,12 @@ These metrics are only emitted by Upjet-based providers (such as [provider-upjet
7575
| --- | --- |
7676
| {{<hover label="upjet_resource_ext_api_duration" line="1">}}upjet_resource_ext_api_duration{{</hover>}} | Measures in seconds how long it takes a Cloud SDK call to complete |
7777
| {{<hover label="upjet_resource_external_api_calls_total" line="2">}}upjet_resource_external_api_calls_total{{</hover>}} | The number of external API calls to cloud providers, with labels describing the endpoints and resources |
78-
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="3">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
79-
| {{<hover label="upjet_resource_ttr" line="4">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
80-
| {{<hover label="upjet_resource_cli_duration" line="5">}}upjet_resource_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
81-
| {{<hover label="upjet_resource_active_cli_invocations" line="6">}}upjet_resource_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
82-
| {{<hover label="upjet_resource_running_processes" line="7">}}upjet_resource_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
78+
| {{<hover label="upjet_resource_deletion_seconds" line="3">}}upjet_resource_deletion_seconds{{</hover>}} | Measures in seconds how long it takes for a resource to be deleted |
79+
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="4">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
80+
| {{<hover label="upjet_resource_ttr" line="5">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
81+
| {{<hover label="upjet_terraform_cli_duration" line="6">}}upjet_terraform_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
82+
| {{<hover label="upjet_terraform_active_cli_invocations" line="7">}}upjet_terraform_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
83+
| {{<hover label="upjet_terraform_running_processes" line="8">}}upjet_terraform_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
8384
{{</table >}}
8485

8586
## Controller-runtime and Kubernetes client metrics

content/v2.1/guides/metrics.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,12 @@ These metrics are only emitted by Upjet-based providers (such as [provider-upjet
218218
| --- | --- |
219219
| {{<hover label="upjet_resource_ext_api_duration" line="1">}}upjet_resource_ext_api_duration{{</hover>}} | Measures in seconds how long it takes a Cloud SDK call to complete |
220220
| {{<hover label="upjet_resource_external_api_calls_total" line="2">}}upjet_resource_external_api_calls_total{{</hover>}} | The number of external API calls to cloud providers, with labels describing the endpoints and resources |
221-
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="3">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
222-
| {{<hover label="upjet_resource_ttr" line="4">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
223-
| {{<hover label="upjet_resource_cli_duration" line="5">}}upjet_resource_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
224-
| {{<hover label="upjet_resource_active_cli_invocations" line="6">}}upjet_resource_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
225-
| {{<hover label="upjet_resource_running_processes" line="7">}}upjet_resource_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
221+
| {{<hover label="upjet_resource_deletion_seconds" line="3">}}upjet_resource_deletion_seconds{{</hover>}} | Measures in seconds how long it takes for a resource to be deleted |
222+
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="4">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
223+
| {{<hover label="upjet_resource_ttr" line="5">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
224+
| {{<hover label="upjet_terraform_cli_duration" line="6">}}upjet_terraform_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
225+
| {{<hover label="upjet_terraform_active_cli_invocations" line="7">}}upjet_terraform_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
226+
| {{<hover label="upjet_terraform_running_processes" line="8">}}upjet_terraform_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
226227
{{</table >}}
227228

228229
## Controller-runtime and Kubernetes client metrics

content/v2.2/guides/metrics.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,12 @@ These metrics are only emitted by Upjet-based providers (such as [provider-upjet
218218
| --- | --- |
219219
| {{<hover label="upjet_resource_ext_api_duration" line="1">}}upjet_resource_ext_api_duration{{</hover>}} | Measures in seconds how long it takes a Cloud SDK call to complete |
220220
| {{<hover label="upjet_resource_external_api_calls_total" line="2">}}upjet_resource_external_api_calls_total{{</hover>}} | The number of external API calls to cloud providers, with labels describing the endpoints and resources |
221-
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="3">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
222-
| {{<hover label="upjet_resource_ttr" line="4">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
223-
| {{<hover label="upjet_resource_cli_duration" line="5">}}upjet_resource_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
224-
| {{<hover label="upjet_resource_active_cli_invocations" line="6">}}upjet_resource_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
225-
| {{<hover label="upjet_resource_running_processes" line="7">}}upjet_resource_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
221+
| {{<hover label="upjet_resource_deletion_seconds" line="3">}}upjet_resource_deletion_seconds{{</hover>}} | Measures in seconds how long it takes for a resource to be deleted |
222+
| {{<hover label="upjet_resource_reconcile_delay_seconds" line="4">}}upjet_resource_reconcile_delay_seconds{{</hover>}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods |
223+
| {{<hover label="upjet_resource_ttr" line="5">}}upjet_resource_ttr{{</hover>}} | Measures in seconds the time-to-readiness (TTR) for managed resources |
224+
| {{<hover label="upjet_terraform_cli_duration" line="6">}}upjet_terraform_cli_duration{{</hover>}} | Measures in seconds how long it takes a Terraform CLI invocation to complete |
225+
| {{<hover label="upjet_terraform_active_cli_invocations" line="7">}}upjet_terraform_active_cli_invocations{{</hover>}} | The number of active (running) Terraform CLI invocations |
226+
| {{<hover label="upjet_terraform_running_processes" line="8">}}upjet_terraform_running_processes{{</hover>}} | The number of running Terraform CLI and Terraform provider processes |
226227
{{</table >}}
227228

228229
## Controller-runtime and Kubernetes client metrics

0 commit comments

Comments
 (0)