diff --git a/_topic_map.yml b/_topic_map.yml index 6c1c54e5b2..a1b4534627 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -799,6 +799,8 @@ Topics: - Name: Resource quotas across multiple projects File: quotas-setting-across-multiple-projects Distros: openshift-enterprise,openshift-webscale,openshift-origin +- Name: Monitoring project and application metrics using the Developer perspective + File: odc-monitoring-project-and-application-metrics-using-developer-perspective - Name: Monitoring application health File: application-health - Name: Working with quotas diff --git a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc new file mode 100644 index 0000000000..85ea452a3d --- /dev/null +++ b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc @@ -0,0 +1,17 @@ +[id="odc-monitoring-project-and-application-metrics-using-developer-perspective"] += Monitoring project and application metrics using the Developer perspective +include::modules/common-attributes.adoc[] +:context: monitoring-project-and-application-metrics-using-developer-perspective +toc::[] + + +The *Monitoring* view in the *Developer* perspective provides options to monitor your project or application metrics, such as CPU, memory, and bandwidth usage, and network related information. + +.Prerequisites + +* You have xref:../web_console/web-console.adoc#web-console-overview[logged in to the web console] and have switched to the xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective]. +* You have xref:../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed applications on {product-title}]. + +include::modules/odc-monitoring-your-project-metrics.adoc[leveloffset=+1] + +include::modules/odc-monitoring-your-application-metrics.adoc[leveloffset=+1] diff --git a/images/odc_app_metrics.png b/images/odc_app_metrics.png new file mode 100644 index 0000000000..8ef08588e5 Binary files /dev/null and b/images/odc_app_metrics.png differ diff --git a/images/odc_project_dashboard.png b/images/odc_project_dashboard.png new file mode 100644 index 0000000000..8dce94a1f0 Binary files /dev/null and b/images/odc_project_dashboard.png differ diff --git a/images/odc_project_events.png b/images/odc_project_events.png new file mode 100644 index 0000000000..f25ae343d2 Binary files /dev/null and b/images/odc_project_events.png differ diff --git a/images/odc_project_metrics.png b/images/odc_project_metrics.png new file mode 100644 index 0000000000..ffeed5afcb Binary files /dev/null and b/images/odc_project_metrics.png differ diff --git a/modules/odc-monitoring-your-application-metrics.adoc b/modules/odc-monitoring-your-application-metrics.adoc new file mode 100644 index 0000000000..760321dcf7 --- /dev/null +++ b/modules/odc-monitoring-your-application-metrics.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc + +[id="odc-monitoring-your-application-metrics_{context}"] += Monitoring your application metrics + +After you create applications in your project and deploy them, you can use the *Topology* view in the *Developer* perspective to see the metrics for your application. + +.Procedure + +. In the *Topology* view, click the application to see the application details in the right panel. +. Click the *Monitoring* tab to see the warning events for the application; graphs for CPU, memory, and bandwidth usage; and all the events for the application. ++ +image::odc_app_metrics.png[Monitoring application metrics] ++ +.. Click any of the charts to go to the *Metrics* tab to see the detailed metrics for the application. +.. Click *View monitoring dashboard* to see the monitoring dashboard for that application. diff --git a/modules/odc-monitoring-your-project-metrics.adoc b/modules/odc-monitoring-your-project-metrics.adoc new file mode 100644 index 0000000000..15dad676b9 --- /dev/null +++ b/modules/odc-monitoring-your-project-metrics.adoc @@ -0,0 +1,43 @@ +// Module included in the following assemblies: +// +// * applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc + +[id="odc-monitoring-your-project-metrics_{context}"] += Monitoring your project metrics + +After you create applications in your project and deploy them, you can use the *Developer* perspective in the web console to see the metrics for your project. + +.Procedure + +. On the left navigation panel of the *Developer* perspective, click *Monitoring* to see the *Dashboard*, *Metrics*, and *Events* for your project. + +* Use the *Dashboard* tab to see graphs depicting the CPU, memory, and bandwidth consumption and network related information, such as the rate of transmitted and received packets and the rate of dropped packets. ++ +image::odc_project_dashboard.png[Monitoring dashboard] ++ +Use the following options to see further details: + +** Select an option from the *Time Range* list to determine the time frame for the data being captured. +** Select an option from the *Refresh Interval* list to determine the time period after which the data is refreshed. +** Hover your cursor over the graphs to see specific details for your Pod. +** Click on any of the graphs displayed to see the details for that particular metric in the *Metrics* page. + +* Use the *Metrics* tab to query for the required project metric. ++ +image::odc_project_metrics.png[Monitoring metrics] ++ +.. In the *Select Query* list, select an option to filter the required details for your project. The filtered metrics for all the application Pods in your project are displayed in the graph. The Pods in your project are also listed below. +.. From the list of Pods, clear the colored square boxes to remove the metrics for specific Pods to further filter your query result. +.. Click *Show PromQL* to see the Prometheus query. You can further modify this query with the help of prompts to customize the query and filter the metrics you want to see for that namespace. +.. Use the drop-down list to set a time range for the data being displayed. You can click *Reset Zoom* to reset it to the default time range. +.. Optionally, in the *Select Query* list, select *Custom Query* to create a custom Prometheus query and filter relevant metrics. + +* Use the *Events* tab to see the events for your project. ++ +image::odc_project_events.png[Monitoring events] ++ +You can filter the displayed events using the following options: + +** In the *Resources* list, select a resource to see events for that resource. +** In the *All Types* list, select a type of event to see events relevant to that type. +** Search for specific events using the *Filter events by names or messages* field.