From 97e3a5d8cbcfc2e5b07e48b40250334ef5d35aa2 Mon Sep 17 00:00:00 2001 From: Avital Pinnick Date: Wed, 27 Oct 2021 16:46:24 +0300 Subject: [PATCH] Fixing problems with PR 35690 --- .../troubleshooting-3-4.adoc | 5 +++-- .../troubleshooting-mtc.adoc | 4 +++- ...performance-metrics-in-ocp-web-console.adoc | 16 ---------------- ...igration-accessing-performance-metrics.adoc | 18 ++++++++++++++++++ ...cs.adoc => migration-provided-metrics.adoc} | 15 ++++++--------- 5 files changed, 30 insertions(+), 28 deletions(-) delete mode 100644 modules/migration-accessing-performance-metrics-in-ocp-web-console.adoc create mode 100644 modules/migration-accessing-performance-metrics.adoc rename modules/{migration-performance-metrics.adoc => migration-provided-metrics.adoc} (85%) diff --git a/migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc b/migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc index f019d08352..6b02a5ffcf 100644 --- a/migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc +++ b/migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc @@ -22,8 +22,9 @@ This section describes logs and debugging tools that you can use for troubleshoo include::modules/migration-viewing-migration-plan-resources.adoc[leveloffset=+2] include::modules/migration-viewing-migration-plan-log.adoc[leveloffset=+2] include::modules/migration-using-mig-log-reader.adoc[leveloffset=+2] -include::modules/migration-performance-metrics.adoc[leveloffset=+2] -include::modules/migration-accessing-performance-metrics-in-ocp-web-console.adoc[leveloffset=+2] +include::modules/migration-accessing-performance-metrics.adoc[leveloffset=+2] +[discrete] +include::modules/migration-provided-metrics.adoc[leveloffset=+3] include::modules/migration-using-must-gather.adoc[leveloffset=+2] include::modules/migration-debugging-velero-resources.adoc[leveloffset=+2] include::modules/migration-partial-failure-velero.adoc[leveloffset=+2] diff --git a/migration_toolkit_for_containers/troubleshooting-mtc.adoc b/migration_toolkit_for_containers/troubleshooting-mtc.adoc index 9268c48420..91b7f2d51f 100644 --- a/migration_toolkit_for_containers/troubleshooting-mtc.adoc +++ b/migration_toolkit_for_containers/troubleshooting-mtc.adoc @@ -22,7 +22,9 @@ This section describes logs and debugging tools that you can use for troubleshoo include::modules/migration-viewing-migration-plan-resources.adoc[leveloffset=+2] include::modules/migration-viewing-migration-plan-log.adoc[leveloffset=+2] include::modules/migration-using-mig-log-reader.adoc[leveloffset=+2] -include::modules/migration-performance-metrics.adoc[leveloffset=+2] +include::modules/migration-accessing-performance-metrics.adoc[leveloffset=+2] +[discrete] +include::modules/migration-provided-metrics.adoc[leveloffset=+3] include::modules/migration-using-must-gather.adoc[leveloffset=+2] include::modules/migration-debugging-velero-resources.adoc[leveloffset=+2] include::modules/migration-partial-failure-velero.adoc[leveloffset=+2] diff --git a/modules/migration-accessing-performance-metrics-in-ocp-web-console.adoc b/modules/migration-accessing-performance-metrics-in-ocp-web-console.adoc deleted file mode 100644 index 91de758047..0000000000 --- a/modules/migration-accessing-performance-metrics-in-ocp-web-console.adoc +++ /dev/null @@ -1,16 +0,0 @@ -// Module included in the following assemblies: -// -// * migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc -// * migration-toolkit-for-containers/troubleshooting-mtc.adoc - -[id="migration-accessing-performance-metrics-in-ocp-web-console_{context}"] -= Accessing performance metrics in the {product-title} web console - -You can access performance metrics and run queries using the {product-title} web console. - -.Procedure -. In the {product-title} 4 web console, click *Monitoring* -> *Metrics*. - -. Enter PromQL queries, select a time window to display, and click *Run Queries*. -+ -If your web browser does not display all the results, use the Prometheus console. diff --git a/modules/migration-accessing-performance-metrics.adoc b/modules/migration-accessing-performance-metrics.adoc new file mode 100644 index 0000000000..7d2b89f13c --- /dev/null +++ b/modules/migration-accessing-performance-metrics.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc +// * migration-toolkit-for-containers/troubleshooting-mtc.adoc + +[id="migration-accessing-performance-metrics_{context}"] += Accessing performance metrics + +The `MigrationController` custom resource (CR) records metrics and pulls them into on-cluster monitoring storage. You can query the metrics by using Prometheus Query Language (PromQL) to diagnose migration performance issues. All metrics are reset when the Migration Controller pod restarts. + +You can access the performance metrics and run queries by using the {product-title} web console. + +.Procedure + +. In the {product-title} web console, click *Monitoring* -> *Metrics*. +. Enter a PromQL query, select a time window to display, and click *Run Queries*. ++ +If your web browser does not display all the results, use the Prometheus console. diff --git a/modules/migration-performance-metrics.adoc b/modules/migration-provided-metrics.adoc similarity index 85% rename from modules/migration-performance-metrics.adoc rename to modules/migration-provided-metrics.adoc index 2c2c1deb47..84c8741f68 100644 --- a/modules/migration-performance-metrics.adoc +++ b/modules/migration-provided-metrics.adoc @@ -3,16 +3,13 @@ // * migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc // * migration-toolkit-for-containers/troubleshooting-mtc.adoc -[id="migration-performance-metrics_{context}"] -= Performance metrics +[id="migration-provided-metrics_{context}"] += Provided metrics -The `MigrationController` custom resource (CR) records a set of metrics and pulls it into on-cluster monitoring storage. You can query the metrics by using Prometheus Query Language (PromQL) to diagnose migration performance issues. All metrics are reset when the Migration Controller pod restarts. - -[id="provided-metrics_{context}"] -== Provided metrics +The `MigrationController` custom resource (CR) provides metrics for the `MigMigration` CR count and for its API requests. [id="cam_app_workload_migrations-metric_{context}"] -=== cam_app_workload_migrations +== cam_app_workload_migrations This metric is a count of `MigMigration` CRs over time. It is useful for viewing alongside the `mtc_client_request_count` and `mtc_client_request_elapsed` metrics to collate API request information with migration status changes. This metric is included in Telemetry. @@ -31,7 +28,7 @@ This metric is a count of `MigMigration` CRs over time. It is useful for viewing |=== [id="mtc_client_request_count-metric_{context}"] -=== mtc_client_request_count +== mtc_client_request_count This metric is a cumulative count of Kubernetes API requests that `MigrationController` issued. It is not included in Telemetry. @@ -58,7 +55,7 @@ This metric is a cumulative count of Kubernetes API requests that `MigrationCont |=== [id="mtc_client_request_elapsed-metric_{context}"] -=== mtc_client_request_elapsed +== mtc_client_request_elapsed This metric is a cumulative latency, in milliseconds, of Kubernetes API requests that `MigrationController` issued. It is not included in Telemetry.