Merge pull request #48342 from smunje1/RHDEVDOCS-3111

RHDEVDOCS-3111: Update monitoring flows and capture customizing metrics

Author: JStickler

applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc

@@ -9,6 +9,7 @@ toc::[]
 
 The *Observe* 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.
 
+[id="prerequisites_odc-monitoring-project-and-application-metrics-using-developer-perspective"]
 == 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].
@@ -23,5 +24,6 @@ include::modules/odc-image-vulnerabilities-breakdown.adoc[leveloffset=+1]
 include::modules/odc-monitoring-your-app-vulnerabilities.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
+[id="additional-resources-odc-monitoring-project-and-application-metrics-using-developer-perspective"]
 == Additional resources
 * xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]

images/observe-dashboard-developer.png

@@ -6,20 +6,26 @@
 [id="reviewing-monitoring-dashboards-developer_{context}"]
 = Reviewing monitoring dashboards as a developer
 
-In the Developer perspective, you can view dashboards relating to a selected project. You must have access to monitor a project to view dashboard information for it.
+Use the Developer perspective to view Kubernetes compute resources dashboards of a selected project.
 
 .Prerequisites
 
-* You have access to the cluster as a developer or as a user with view permissions for the project that you are viewing the dashboard for.
+* You have access to the cluster as a developer or as a user. 
+* You have view permissions for the project that you are viewing the dashboard for.
 
 .Procedure
 
 . In the Developer perspective in the {product-title} web console, navigate to *Observe* -> *Dashboard*.
 
-. Choose a project in the *Project:* list.
-
-. Choose a workload in the *All Workloads* list.
+. Select a project from the *Project:* drop-down list.
 
+. Select a dashboard from the *Dashboard* drop-down list to see the filtered metrics.
++
+[NOTE]
+====
+All dashboards produce additional sub-menus when selected, except *Kubernetes / Compute Resources / Namespace (Pods)*.
+====
++
 . Optional: Select a time range for the graphs in the *Time Range* list.
 +
 ** Select a pre-defined time period.

images/odc_observe_dashboard.png

@@ -11,21 +11,36 @@ After you create applications in your project and deploy them, you can use the *
 .Procedure
 
 . On the left navigation panel of the *Developer* perspective, click *Observe* to see the *Dashboard*, *Metrics*, *Alerts*, 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.
 +
-.Monitoring dashboard
-image::odc_project_dashboard.png[]
+. Optional: Use the *Dashboard* tab to see graphs depicting the following application metrics:
++
+--
+* CPU usage 
+* Memory usage
+* Bandwidth consumption
+* Network-related information such as the rate of transmitted and received packets and the rate of dropped packets.
+--
++
+In the *Dashboard* tab, you can access the Kubernetes compute resources dashboards.
++
+.Observe dashboard
+image::odc_observe_dashboard.png[]
++
+[NOTE]
+====
+In the *Dashboard* list, *Kubernetes / Compute Resources / Namespace (Pods)* dashboard is selected by default.
+====
 +
 Use the following options to see further details:
 
-** Select a workload from the *All Workloads* list to see the filtered metrics for the selected workload.
+** Select a dashboard from the *Dashboard* list to see the filtered metrics. All dashboards produce additional sub-menus when selected, except *Kubernetes / Compute Resources / Namespace (Pods)*.
 ** Select an option from the *Time Range* list to determine the time frame for the data being captured.
+** Set a custom time range by selecting *Custom time range* from the *Time Range* list. You can input or select the *From* and *To* dates and times. Click *Save* to save the custom time range.
 ** 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.
+** Click *Inspect* located in the upper-right corner of every graph to see any particular graph details. The graph details appear in the *Metrics* tab.
 
-* Use the *Metrics* tab to query for the required project metric.
+. Optional: Use the *Metrics* tab to query for the required project metric.
 +
 .Monitoring metrics
 image::odc_project_metrics.png[]
@@ -36,11 +51,19 @@ image::odc_project_metrics.png[]
 .. 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.
 .. Optional: In the *Select Query* list, select *Custom Query* to create a custom Prometheus query and filter relevant metrics.
 
-* Use the *Alerts* tab to see the rules that trigger alerts for the applications in your project, identify the alerts firing in the project, and silence them if required.
+. Optional: Use the *Alerts* tab to do the following tasks:
++
+--
+* See the rules that trigger alerts for the applications in your project.
+* Identify the alerts firing in the project.
+* Silence such alerts if required.
+--
 +
 .Monitoring alerts
 image::odc_project_alerts.png[]
 +
+Use the following options to see further details:
+
 ** Use the *Filter* list to filter the alerts by their *Alert State* and *Severity*.
 
 ** Click on an alert to go to the details page for that alert. In the *Alerts Details* page, you can click *View Metrics* to see the metrics for the alert.
@@ -50,7 +73,7 @@ You must have the permissions to edit alerts to see the *Notifications* toggle.
 
 ** Use the *Options* menu {kebab} adjoining an alert rule to see the details of the alerting rule.
 
-* Use the *Events* tab to see the events for your project.
+. Optional: Use the *Events* tab to see the events for your project.
 +
 .Monitoring events
 image::odc_project_events.png[]

modules/monitoring-reviewing-monitoring-dashboards-developer.adoc

@@ -8,7 +8,7 @@ toc::[]
 
 {product-title} {product-version} provides a comprehensive set of monitoring dashboards that help you understand the state of cluster components and user-defined workloads.
 
-In the *Administrator* perspective you can access dashboards for core {product-title} components, including:
+Use the *Administrator* perspective to access dashboards for the core {product-title} components, including the following items:
 
 * API performance
 * etcd
@@ -20,15 +20,15 @@ In the *Administrator* perspective you can access dashboards for core {product-t
 .Example dashboard in the Administrator perspective
 image::monitoring-dashboard-administrator.png[]
 
-In the *Developer* perspective you can access dashboards that provide the following statistics for a selected project:
+Use the *Developer* perspective to access Kubernetes compute resources dashboards that provide the following application metrics for a selected project:
 
 * CPU usage
 * Memory usage
 * Bandwidth information
 * Packet rate information
 
 .Example dashboard in the Developer perspective
-image::monitoring-dashboard-developer.png[]
+image::observe-dashboard-developer.png[]
 
 [NOTE]
 ====
@@ -42,6 +42,7 @@ include::modules/monitoring-reviewing-monitoring-dashboards-admin.adoc[leveloffs
 include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
+[id="additional-resources-reviewing-monitoring-dashboards"]
 .Additional resources
 
 * xref:../applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc#monitoring-project-and-application-metrics-using-developer-perspective[Monitoring project and application metrics using the Developer perspective]