From 3885f028926c9318b70237af5ad077c316422145 Mon Sep 17 00:00:00 2001 From: shwethamuralikrishnaa Date: Fri, 23 Aug 2024 14:40:40 +0200 Subject: [PATCH 1/9] Add readme for Crossplane metrics Signed-off-by: shwethamuralikrishnaa shwetha.muralikrishnaa@sap.com Signed-off-by: shwethamuralikrishnaa Signed-off-by: Pierluigi Lenoci --- content/master/concepts/_index.md | 3 ++ content/master/concepts/metrics.md | 44 ++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 content/master/concepts/metrics.md diff --git a/content/master/concepts/_index.md b/content/master/concepts/_index.md index 3c821d9e..20c9d7bd 100644 --- a/content/master/concepts/_index.md +++ b/content/master/concepts/_index.md @@ -78,3 +78,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 quickly identify and resolve potential issues. diff --git a/content/master/concepts/metrics.md b/content/master/concepts/metrics.md new file mode 100644 index 00000000..f4f6fa71 --- /dev/null +++ b/content/master/concepts/metrics.md @@ -0,0 +1,44 @@ +--- +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 within your Crossplane environment. +Understanding these metrics will help you maintain the health and performance of your resources, ensuring that any issues can be quickly identified and addressed. +Please note that this document focuses exclusively on Crossplane-specific metrics and does not 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 currently used workers per controller | The number of threads that currently process jobs from the work queue. | +| {{}}controller_runtime_max_concurrent_reconciles{{}} | Maximum number of concurrent reconciles per controller | Describes how many 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 being 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{{}} | How many 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 being requested | The time it takes from the moment a job is added to the workqueue until the processing of this job starts. | +| {{}}workqueue_retries_total{{}} | Total number of retries handled by workqueue | | +| {{}}workqueue_unfinished_work_seconds{{}} | How many seconds of work has been done that is in progress and hasn't been observed by work_duration. Large values indicate 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 is picked up until it is finished (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 which endpoints resources have been queried. | +| {{}}upjet_resource_reconcile_delay_seconds_bucket{{}} | Measures in seconds how long the reconciles for a resource have been delayed from the configured poll periods | | +| {{}}crossplane_managed_resource_deletion_seconds_bucket{{}} | The time it took for a managed resource to be deleted | | +| {{}}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 for a managed resource to be detected by the controller | | +| {{}}upjet_resource_ttr_bucket{{}} | Measures in seconds the time-to-readiness (TTR) for managed resources | | +{{< /table >}} From 47da6d618dcd4d0c6f89fa24f717bdc058cd87e1 Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Fri, 6 Sep 2024 16:09:42 +0200 Subject: [PATCH 2/9] lint-fix Vale Signed-off-by: Pierluigi Lenoci --- content/master/concepts/_index.md | 4 +-- content/master/concepts/metrics.md | 44 +++++++++++++++--------------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/content/master/concepts/_index.md b/content/master/concepts/_index.md index 20c9d7bd..c5f11ce1 100644 --- a/content/master/concepts/_index.md +++ b/content/master/concepts/_index.md @@ -79,5 +79,5 @@ building and managing external resources through Kubernetes. 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 quickly identify and resolve potential issues. +* [**Metrics**]({{}}) are essential for monitoring Crossplane's + operations, helping to identify and resolve potential issues. diff --git a/content/master/concepts/metrics.md b/content/master/concepts/metrics.md index f4f6fa71..b2303633 100644 --- a/content/master/concepts/metrics.md +++ b/content/master/concepts/metrics.md @@ -4,41 +4,41 @@ 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 within your Crossplane environment. -Understanding these metrics will help you maintain the health and performance of your resources, ensuring that any issues can be quickly identified and addressed. -Please note that this document focuses exclusively on Crossplane-specific metrics and does not cover standard Go metrics. +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. +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 currently used workers per controller | The number of threads that currently process jobs from the work queue. | -| {{}}controller_runtime_max_concurrent_reconciles{{}} | Maximum number of concurrent reconciles per controller | Describes how many 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_active_workers{{}} | Number of used workers per controller | The number of threads that currently process 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 being served | | +| {{}}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{{}} | How many 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 being requested | The time it takes from the moment a job is added to the workqueue until the processing of this job starts. | -| {{}}workqueue_retries_total{{}} | Total number of retries handled by workqueue | | -| {{}}workqueue_unfinished_work_seconds{{}} | How many seconds of work has been done that is in progress and hasn't been observed by work_duration. Large values indicate 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 is picked up until it is finished (either successfully or with an error). | +| {{}}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_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_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 | | +| {{}}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 which endpoints resources have been queried. | -| {{}}upjet_resource_reconcile_delay_seconds_bucket{{}} | Measures in seconds how long the reconciles for a resource have been delayed from the configured poll periods | | -| {{}}crossplane_managed_resource_deletion_seconds_bucket{{}} | The time it took for a managed resource to be deleted | | +| {{}}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 for a managed resource to be detected by the controller | | -| {{}}upjet_resource_ttr_bucket{{}} | Measures in seconds the time-to-readiness (TTR) for managed resources | | +| {{}}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 >}} From 4a0af101b03cea7ffe0a4f419230ecb3b99fea23 Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Mon, 9 Sep 2024 10:53:02 +0200 Subject: [PATCH 3/9] 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 >}} From 0b7ce7d5365360be6cdd415bc1291390c52b36f5 Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Mon, 9 Sep 2024 12:18:04 +0200 Subject: [PATCH 4/9] fix markdown 2 Signed-off-by: Pierluigi Lenoci --- content/master/concepts/metrics.md | 1 - content/v1.17/concepts/metrics.md | 1 - 2 files changed, 2 deletions(-) diff --git a/content/master/concepts/metrics.md b/content/master/concepts/metrics.md index e1300083..7e1062f3 100644 --- a/content/master/concepts/metrics.md +++ b/content/master/concepts/metrics.md @@ -40,4 +40,3 @@ Please note that this document focuses on Crossplane specific metrics and doesn' | {{}}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 >}} diff --git a/content/v1.17/concepts/metrics.md b/content/v1.17/concepts/metrics.md index e1300083..7e1062f3 100644 --- a/content/v1.17/concepts/metrics.md +++ b/content/v1.17/concepts/metrics.md @@ -40,4 +40,3 @@ Please note that this document focuses on Crossplane specific metrics and doesn' | {{}}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 >}} From da78ef276bb2db1826158cb97feab73bc6c9e18e Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Mon, 9 Sep 2024 12:33:25 +0200 Subject: [PATCH 5/9] I hate Vale Signed-off-by: Pierluigi Lenoci --- content/master/concepts/metrics.md | 2 +- content/v1.17/concepts/metrics.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/master/concepts/metrics.md b/content/master/concepts/metrics.md index 7e1062f3..b2802e4f 100644 --- a/content/master/concepts/metrics.md +++ b/content/master/concepts/metrics.md @@ -5,7 +5,7 @@ description: "Metrics are essential for monitoring Crossplane's operations, help --- 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. +Understanding these metrics help you maintain the health and performance of your resources, ensuring to identify and address any issues. Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics. diff --git a/content/v1.17/concepts/metrics.md b/content/v1.17/concepts/metrics.md index 7e1062f3..b2802e4f 100644 --- a/content/v1.17/concepts/metrics.md +++ b/content/v1.17/concepts/metrics.md @@ -5,7 +5,7 @@ description: "Metrics are essential for monitoring Crossplane's operations, help --- 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. +Understanding these metrics help you maintain the health and performance of your resources, ensuring to identify and address any issues. Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics. From 3f328bf84bbd3084880bbf24b2be06cafd98e0bb Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Tue, 10 Sep 2024 14:58:35 +0200 Subject: [PATCH 6/9] Added the prometheus related infos Signed-off-by: Pierluigi Lenoci --- content/master/concepts/metrics.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/content/master/concepts/metrics.md b/content/master/concepts/metrics.md index b2802e4f..f220c809 100644 --- a/content/master/concepts/metrics.md +++ b/content/master/concepts/metrics.md @@ -4,10 +4,24 @@ 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 to identify and address any issues. -Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics. +Crossplane produces numerous [Prometheus-style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment. +These metrics are essential for helping to identify and resolve potential issues quickly. +This page offers explanations of all these metrics gathered from Crossplane. +Understanding these metrics helps you maintain the health and performance of your resources. +Please note that this document focuses on Crossplane-specific metrics and doesn't cover standard Go metrics. +To enable the export of metrics it is necessary to configure the `--set metrics.enabled=true` option in the [helm chart](https://github.com/crossplane/crossplane/blob/main/cluster/charts/crossplane/README.md#configuration). +```yaml {label="value",copy-lines="none"} +metrics: + enabled: true +``` + +The metrics are exposed using these Prometheus annotations: +```yaml {label="deployment",copy-lines="none"} +prometheus.io/path: /metrics +prometheus.io/port: "8080" +prometheus.io/scrape: "true" +``` | Metric Name | Description | Further Explanation | | --- | --- | --- | From 6357c10dfbce20d6204792486ef436c93df54330 Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Tue, 10 Sep 2024 15:02:40 +0200 Subject: [PATCH 7/9] Moved in another location Signed-off-by: Pierluigi Lenoci --- content/master/concepts/_index.md | 3 --- .../master/{concepts => guides}/metrics.md | 0 content/v1.17/concepts/_index.md | 3 --- content/v1.17/{concepts => guides}/metrics.md | 20 ++++++++++++++++--- 4 files changed, 17 insertions(+), 9 deletions(-) rename content/master/{concepts => guides}/metrics.md (100%) rename content/v1.17/{concepts => guides}/metrics.md (86%) diff --git a/content/master/concepts/_index.md b/content/master/concepts/_index.md index bb1e47dc..1407bfb6 100644 --- a/content/master/concepts/_index.md +++ b/content/master/concepts/_index.md @@ -68,6 +68,3 @@ 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/master/concepts/metrics.md b/content/master/guides/metrics.md similarity index 100% rename from content/master/concepts/metrics.md rename to content/master/guides/metrics.md diff --git a/content/v1.17/concepts/_index.md b/content/v1.17/concepts/_index.md index bb1e47dc..1407bfb6 100644 --- a/content/v1.17/concepts/_index.md +++ b/content/v1.17/concepts/_index.md @@ -68,6 +68,3 @@ 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/guides/metrics.md similarity index 86% rename from content/v1.17/concepts/metrics.md rename to content/v1.17/guides/metrics.md index b2802e4f..f220c809 100644 --- a/content/v1.17/concepts/metrics.md +++ b/content/v1.17/guides/metrics.md @@ -4,10 +4,24 @@ 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 to identify and address any issues. -Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics. +Crossplane produces numerous [Prometheus-style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment. +These metrics are essential for helping to identify and resolve potential issues quickly. +This page offers explanations of all these metrics gathered from Crossplane. +Understanding these metrics helps you maintain the health and performance of your resources. +Please note that this document focuses on Crossplane-specific metrics and doesn't cover standard Go metrics. +To enable the export of metrics it is necessary to configure the `--set metrics.enabled=true` option in the [helm chart](https://github.com/crossplane/crossplane/blob/main/cluster/charts/crossplane/README.md#configuration). +```yaml {label="value",copy-lines="none"} +metrics: + enabled: true +``` + +The metrics are exposed using these Prometheus annotations: +```yaml {label="deployment",copy-lines="none"} +prometheus.io/path: /metrics +prometheus.io/port: "8080" +prometheus.io/scrape: "true" +``` | Metric Name | Description | Further Explanation | | --- | --- | --- | From 1901e55499589098649df97f1f4886bab71096a4 Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Tue, 10 Sep 2024 15:06:26 +0200 Subject: [PATCH 8/9] Integrated Jared suggestion Signed-off-by: Pierluigi Lenoci --- content/master/guides/metrics.md | 2 ++ content/v1.17/guides/metrics.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/content/master/guides/metrics.md b/content/master/guides/metrics.md index f220c809..5046af70 100644 --- a/content/master/guides/metrics.md +++ b/content/master/guides/metrics.md @@ -23,6 +23,7 @@ prometheus.io/port: "8080" prometheus.io/scrape: "true" ``` +{{< table "table table-hover table-striped table-sm">}} | Metric Name | Description | Further Explanation | | --- | --- | --- | | {{}}certwatcher_read_certificate_errors_total{{}} | Total number of certificate read errors | | @@ -54,3 +55,4 @@ prometheus.io/scrape: "true" | {{}}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 | | +{{
}} \ No newline at end of file diff --git a/content/v1.17/guides/metrics.md b/content/v1.17/guides/metrics.md index f220c809..5046af70 100644 --- a/content/v1.17/guides/metrics.md +++ b/content/v1.17/guides/metrics.md @@ -23,6 +23,7 @@ prometheus.io/port: "8080" prometheus.io/scrape: "true" ``` +{{< table "table table-hover table-striped table-sm">}} | Metric Name | Description | Further Explanation | | --- | --- | --- | | {{}}certwatcher_read_certificate_errors_total{{}} | Total number of certificate read errors | | @@ -54,3 +55,4 @@ prometheus.io/scrape: "true" | {{}}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 | | +{{}} \ No newline at end of file From 9c4d1fd5dc7fb5ec46b6bfcda1d8fc945bc1e8fc Mon Sep 17 00:00:00 2001 From: Pierluigi Lenoci Date: Tue, 10 Sep 2024 18:02:05 +0200 Subject: [PATCH 9/9] Vale I hate you Signed-off-by: Pierluigi Lenoci --- content/master/guides/metrics.md | 10 +++++----- content/v1.17/guides/metrics.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/content/master/guides/metrics.md b/content/master/guides/metrics.md index 5046af70..d46bff2c 100644 --- a/content/master/guides/metrics.md +++ b/content/master/guides/metrics.md @@ -4,19 +4,19 @@ weight: 60 description: "Metrics are essential for monitoring Crossplane's operations, helping to quickly identify and resolve potential issues." --- -Crossplane produces numerous [Prometheus-style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment. -These metrics are essential for helping to identify and resolve potential issues quickly. +Crossplane produces [Prometheus style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment. +These metrics are essential for helping to identify and resolve potential issues. This page offers explanations of all these metrics gathered from Crossplane. Understanding these metrics helps you maintain the health and performance of your resources. -Please note that this document focuses on Crossplane-specific metrics and doesn't cover standard Go metrics. +Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics. -To enable the export of metrics it is necessary to configure the `--set metrics.enabled=true` option in the [helm chart](https://github.com/crossplane/crossplane/blob/main/cluster/charts/crossplane/README.md#configuration). +To enable the export of metrics it's necessary to configure the `--set metrics.enabled=true` option in the [helm chart](https://github.com/crossplane/crossplane/blob/main/cluster/charts/crossplane/README.md#configuration). ```yaml {label="value",copy-lines="none"} metrics: enabled: true ``` -The metrics are exposed using these Prometheus annotations: +These Prometheus annotations expose the metrics: ```yaml {label="deployment",copy-lines="none"} prometheus.io/path: /metrics prometheus.io/port: "8080" diff --git a/content/v1.17/guides/metrics.md b/content/v1.17/guides/metrics.md index 5046af70..d46bff2c 100644 --- a/content/v1.17/guides/metrics.md +++ b/content/v1.17/guides/metrics.md @@ -4,19 +4,19 @@ weight: 60 description: "Metrics are essential for monitoring Crossplane's operations, helping to quickly identify and resolve potential issues." --- -Crossplane produces numerous [Prometheus-style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment. -These metrics are essential for helping to identify and resolve potential issues quickly. +Crossplane produces [Prometheus style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment. +These metrics are essential for helping to identify and resolve potential issues. This page offers explanations of all these metrics gathered from Crossplane. Understanding these metrics helps you maintain the health and performance of your resources. -Please note that this document focuses on Crossplane-specific metrics and doesn't cover standard Go metrics. +Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics. -To enable the export of metrics it is necessary to configure the `--set metrics.enabled=true` option in the [helm chart](https://github.com/crossplane/crossplane/blob/main/cluster/charts/crossplane/README.md#configuration). +To enable the export of metrics it's necessary to configure the `--set metrics.enabled=true` option in the [helm chart](https://github.com/crossplane/crossplane/blob/main/cluster/charts/crossplane/README.md#configuration). ```yaml {label="value",copy-lines="none"} metrics: enabled: true ``` -The metrics are exposed using these Prometheus annotations: +These Prometheus annotations expose the metrics: ```yaml {label="deployment",copy-lines="none"} prometheus.io/path: /metrics prometheus.io/port: "8080"