From 4a0af101b03cea7ffe0a4f419230ecb3b99fea23 Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Mon, 9 Sep 2024 10:53:02 +0200 Subject: [PATCH] fix markdown, duplicated in v.1.17, lint fix Signed-off-by: Pierluigi Lenoci --- content/master/concepts/metrics.md | 11 ++++---- content/v1.17/concepts/_index.md | 3 +++ content/v1.17/concepts/metrics.md | 43 ++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 6 deletions(-) create mode 100644 content/v1.17/concepts/metrics.md diff --git a/content/master/concepts/metrics.md b/content/master/concepts/metrics.md index b2303633..e1300083 100644 --- a/content/master/concepts/metrics.md +++ b/content/master/concepts/metrics.md @@ -4,18 +4,17 @@ weight: 60 description: "Metrics are essential for monitoring Crossplane's operations, helping to quickly identify and resolve potential issues." --- -This page offers explanations of various metrics gathered from Crossplane, which are essential for effective monitoring and alerting in your Crossplane environment. -Understanding these metrics help you maintain the health and performance of your resources, ensuring that any issues can be identified and addressed. +This page offers explanations of various metrics gathered from Crossplane, which are essential for effective monitoring and alerting in your Crossplane environment. +Understanding these metrics help you maintain the health and performance of your resources, ensuring that any issues are identified and addressed. Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics. -{{}} | Metric Name | Description | Further Explanation | | --- | --- | --- | | {{}}certwatcher_read_certificate_errors_total{{}} | Total number of certificate read errors | | | {{}}certwatcher_read_certificate_total{{}} | Total number of certificate reads | | | {{}}composition_run_function_seconds_bucket{{}} | Histogram of RunFunctionResponse latency (seconds) | | -| {{}}controller_runtime_active_workers{{}} | Number of used workers per controller | The number of threads that currently process jobs from the work queue. | +| {{}}controller_runtime_active_workers{{}} | Number of used workers per controller | The number of threads processing jobs from the work queue. | | {{}}controller_runtime_max_concurrent_reconciles{{}} | Maximum number of concurrent reconciles per controller | Describes how reconciles can happen in parallel. | | {{}}controller_runtime_reconcile_errors_total{{}} | Total number of reconciliation errors per controller | A counter that counts reconcile errors. Sharp or non stop rising of this metric might be a problem. | | {{}}controller_runtime_reconcile_time_seconds_bucket{{}} | Length of time per reconciliation per controller | | @@ -26,10 +25,10 @@ Please note that this document focuses on Crossplane specific metrics and doesn' | {{}}rest_client_requests_total{{}} | Number of HTTP requests, partitioned by status code, method, and host | | | {{}}workqueue_adds_total{{}} | Total number of adds handled by `workqueue` | | | {{}}workqueue_depth{{}} | Current depth of `workqueue` | | -| {{}}workqueue_longest_running_processor_seconds{{}} | How many seconds has the longest running processor for `workqueue` been running | | +| {{}}workqueue_longest_running_processor_seconds{{}} | The number of seconds has the longest running processor for `workqueue` been running | | | {{}}workqueue_queue_duration_seconds_bucket{{}} | How long in seconds an item stays in `workqueue` before requested | The time it takes from the moment a job enter the `workqueue` until the processing of this job starts. | | {{}}workqueue_retries_total{{}} | Total number of retries handled by `workqueue` | | -| {{}}workqueue_unfinished_work_seconds{{}} | The number of seconds of work has been done that's in progress and hasn't observed by `work_duration`. Large values means stuck threads. | | +| {{}}workqueue_unfinished_work_seconds{{}} | The number of seconds of work done that's in progress and hasn't observed by `work_duration`. Large values means stuck threads. | | | {{}}workqueue_work_duration_seconds_bucket{{}} | How long in seconds processing an item from `workqueue` takes | The time it takes from the moment the job start until it finish (either successfully or with an error). | | {{}}crossplane_managed_resource_exists{{}} | The number of managed resources that exist | | | {{}}crossplane_managed_resource_ready{{}} | The number of managed resources in `Ready=True` state | | diff --git a/content/v1.17/concepts/_index.md b/content/v1.17/concepts/_index.md index 1407bfb6..bb1e47dc 100644 --- a/content/v1.17/concepts/_index.md +++ b/content/v1.17/concepts/_index.md @@ -68,3 +68,6 @@ building and managing external resources through Kubernetes. * [**Packages**]({{}}) are a convenient way to package up an entire custom platform and define any other Crossplane related requirements. Packages define how to install Providers, custom APIs or composition functions. + +* [**Metrics**]({{}}) are essential for monitoring Crossplane's + operations, helping to identify and resolve potential issues. diff --git a/content/v1.17/concepts/metrics.md b/content/v1.17/concepts/metrics.md new file mode 100644 index 00000000..e1300083 --- /dev/null +++ b/content/v1.17/concepts/metrics.md @@ -0,0 +1,43 @@ +--- +title: Metrics +weight: 60 +description: "Metrics are essential for monitoring Crossplane's operations, helping to quickly identify and resolve potential issues." +--- + +This page offers explanations of various metrics gathered from Crossplane, which are essential for effective monitoring and alerting in your Crossplane environment. +Understanding these metrics help you maintain the health and performance of your resources, ensuring that any issues are identified and addressed. +Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics. + + +| Metric Name | Description | Further Explanation | +| --- | --- | --- | +| {{}}certwatcher_read_certificate_errors_total{{}} | Total number of certificate read errors | | +| {{}}certwatcher_read_certificate_total{{}} | Total number of certificate reads | | +| {{}}composition_run_function_seconds_bucket{{}} | Histogram of RunFunctionResponse latency (seconds) | | +| {{}}controller_runtime_active_workers{{}} | Number of used workers per controller | The number of threads processing jobs from the work queue. | +| {{}}controller_runtime_max_concurrent_reconciles{{}} | Maximum number of concurrent reconciles per controller | Describes how reconciles can happen in parallel. | +| {{}}controller_runtime_reconcile_errors_total{{}} | Total number of reconciliation errors per controller | A counter that counts reconcile errors. Sharp or non stop rising of this metric might be a problem. | +| {{}}controller_runtime_reconcile_time_seconds_bucket{{}} | Length of time per reconciliation per controller | | +| {{}}controller_runtime_reconcile_total{{}} | Total number of reconciliations per controller | | +| {{}}controller_runtime_webhook_latency_seconds_bucket{{}} | Histogram of the latency of processing admission requests | | +| {{}}controller_runtime_webhook_requests_in_flight{{}} | Current number of admission requests served | | +| {{}}controller_runtime_webhook_requests_total{{}} | Total number of admission requests by HTTP status code | | +| {{}}rest_client_requests_total{{}} | Number of HTTP requests, partitioned by status code, method, and host | | +| {{}}workqueue_adds_total{{}} | Total number of adds handled by `workqueue` | | +| {{}}workqueue_depth{{}} | Current depth of `workqueue` | | +| {{}}workqueue_longest_running_processor_seconds{{}} | The number of seconds has the longest running processor for `workqueue` been running | | +| {{}}workqueue_queue_duration_seconds_bucket{{}} | How long in seconds an item stays in `workqueue` before requested | The time it takes from the moment a job enter the `workqueue` until the processing of this job starts. | +| {{}}workqueue_retries_total{{}} | Total number of retries handled by `workqueue` | | +| {{}}workqueue_unfinished_work_seconds{{}} | The number of seconds of work done that's in progress and hasn't observed by `work_duration`. Large values means stuck threads. | | +| {{}}workqueue_work_duration_seconds_bucket{{}} | How long in seconds processing an item from `workqueue` takes | The time it takes from the moment the job start until it finish (either successfully or with an error). | +| {{}}crossplane_managed_resource_exists{{}} | The number of managed resources that exist | | +| {{}}crossplane_managed_resource_ready{{}} | The number of managed resources in `Ready=True` state | | +| {{}}crossplane_managed_resource_synced{{}} | The number of managed resources in `Synced=True` state | | +| {{}}upjet_resource_ext_api_duration_bucket{{}} | Measures in seconds how long it takes a Cloud SDK call to complete | | +| {{}}upjet_resource_external_api_calls_total{{}} | The number of external API calls | The number of calls to cloud providers, with labels describing the endpoints resources. | +| {{}}upjet_resource_reconcile_delay_seconds_bucket{{}} | Measures in seconds how long the reconciles for a resource delay from the configured poll periods | | +| {{}}crossplane_managed_resource_deletion_seconds_bucket{{}} | The time it took to delete a managed resource | | +| {{}}crossplane_managed_resource_first_time_to_readiness_seconds_bucket{{}} | The time it took for a managed resource to become ready first time after creation | | +| {{}}crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{{}} | The time it took to detect a managed resource by the controller | | +| {{}}upjet_resource_ttr_bucket{{}} | Measures in seconds the `time-to-readiness` `(TTR)` for managed resources | | +{{< /table >}}