Merge pull request #32877 from abrennan89/monitoringupdates

SRVCOM-1171: Update monitoring docs

Author: abrennan89

_topic_map.yml

@@ -2905,6 +2905,9 @@ Topics:
     # Serving
   - Name: Creating Knative Serving components in the Administrator perspective
     File: serverless-cluster-admin-serving
+    # Monitoring
+  - Name: Monitoring serverless components
+    File: serverless-admin-monitoring
     # Metering
   - Name: Using metering with OpenShift Serverless
     File: serverless-metering
@@ -3022,12 +3025,6 @@ Topics:
     File: serverless-ossm-custom-domains
   - Name: Configuring TLS for a custom domain using Service Mesh
     File: serverless-ossm-tls
-# Monitoring
-- Name: Monitoring
-  Dir: monitoring
-  Topics:
-  - Name: Monitoring serverless components
-    File: serverless-monitoring
 # Integrations
 - Name: Integrations
   Dir: integrations

images/knative-admin-health-status-dash.png

@@ -0,0 +1,34 @@
+// Module included in the following assemblies:
+//
+// * serverless/admin_guide/serverless-admin-monitoring.adoc
+
+[id="serverless-admin-monitoring-eventing-broker-trigger_{context}"]
+= Monitoring Knative Eventing brokers and triggers
+
+You can use the {product-title} monitoring dashboards to view metrics for brokers and triggers in your cluster.
+
+.Prerequisites
+
+* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+* You have installed the {ServerlessOperatorName}, as well as the Knative Eventing component.
+* The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
+
+.Procedure
+
+. In the *Administrator* perspective, navigate to *Monitoring* -> *Dashboards*.
+. Select the *Knative Eventing - Broker/Trigger* dashboard in the *Dashboard* drop-down list.
+. You can now view the following metrics:
+.. For brokers:
+*** Event Count (rate per minute)
+*** Success Rate (2xx Event, rate per minute)
+*** Event Count by Event Type (rate per minute)
+*** Failure Rate (non-2xx Event, fraction of rate per minute)
+*** Event Count by Response Code Class (rate per minute)
+*** Event Dispatch Latency (ms)
+.. For triggers:
+*** Event Count (rate per minute)
+*** Success Rate (2xx Event, fraction rate per minute)
+*** Event Count by Response Code Class (rate per minute)
+*** Failure Rate (non-2xx Event, fraction rate per minute)
+*** Event Dispatch Latency (ms)
+*** Event Processing Latency (ms)

images/knative-health-status-dash.png

@@ -0,0 +1,23 @@
+// Module included in the following assemblies:
+//
+// * serverless/admin_guide/serverless-admin-monitoring.adoc
+
+[id="serverless-admin-monitoring-eventing-cpu-memory_{context}"]
+= Monitoring Knative Eventing source CPU and memory usage
+
+You can use the {product-title} monitoring dashboards to view source CPU and memory usage metrics for Knative Eventing components.
+
+.Prerequisites
+
+* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+* You have installed the {ServerlessOperatorName}, as well as the Knative Eventing component.
+* The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
+
+.Procedure
+
+. In the *Administrator* perspective, navigate to *Monitoring* -> *Dashboards*.
+. Select the *Knative Eventing - Source CPU and Memory Usage* dashboard in the *Dashboard* drop-down list to view the following metrics:
+** Total CPU Usage (rate per minute)
+** Total Memory Usage (bytes)
+** Total Network I/O (rate per minute)
+** Total Network Errors (rate per minute)

images/knative-serving-cpu-memory-dash.png

@@ -0,0 +1,35 @@
+// Module included in the following assemblies:
+//
+// * serverless/admin_guide/serverless-admin-monitoring.adoc
+
+[id="serverless-admin-monitoring-eventing-sources_{context}"]
+= Monitoring event sources
+
+You can use the {product-title} monitoring dashboards to view metrics for event sources in your cluster.
+
+.Prerequisites
+
+* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+* You have installed the {ServerlessOperatorName}, as well as the Knative Eventing component.
+* The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
+
+.Procedure
+
+. In the *Administrator* perspective, navigate to *Monitoring* -> *Dashboards*.
+. Select the *Knative Eventing - Sources* dashboard in the *Dashboard* drop-down list.
+. You can now view the following metrics:
+.. For API server sources:
+*** Event Count (rate per minute)
+*** Success Rate (2xx Event, fraction rate per minute)
+*** Event Count by Response Code Class (rate per minute)
+*** Failure Rate (non-2xx Event, fraction rate per minute)
+.. For ping sources:
+*** Event Count (rate per minute)
+*** Success Rate (2xx Event, fraction rate per minute)
+*** Event Count by Response Code Class (rate per minute)
+*** Failure Rate (non-2xx Event, fraction rate per minute)
+.. For Kafka sources:
+*** Event Count (rate per minute)
+*** Success Rate (2xx Event, fraction rate per minute)
+*** Event Count by Response Code Class (rate per minute)
+*** Failure Rate (non-2xx Event, fraction rate per minute)

modules/serverless-admin-monitoring-eventing-broker-trigger.adoc

@@ -0,0 +1,23 @@
+// Module included in the following assemblies:
+//
+// * serverless/admin_guide/serverless-admin-monitoring.adoc
+
+[id="serverless-admin-monitoring-health-status_{context}"]
+= Monitoring the overall health status of Knative components
+
+You can use the {product-title} monitoring dashboards to view the overall health status of Knative.
+
+.Prerequisites
+
+* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+* You have installed the {ServerlessOperatorName}, as well as the Knative Serving or Knative Eventing components.
+* The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
+
+.Procedure
+
+. In the *Administrator* perspective, navigate to *Monitoring* -> *Dashboards*.
+. Select the *Knative Health Status* dashboard in the *Dashboard* drop-down to view the overall health status of Knative. If your Knative deployment is running as expected, the dashboard shows a status of *Ready*.
++
+image::knative-admin-health-status-dash.png[Knative Health Status dashboard]
++
+If you have Knative Serving or Knative Eventing installed, you can also scroll down to see the health status for each of these components.

modules/serverless-admin-monitoring-eventing-cpu-memory.adoc

@@ -0,0 +1,24 @@
+// Module included in the following assemblies:
+//
+// * serverless/admin_guide/serverless-admin-monitoring.adoc
+
+[id="serverless-admin-monitoring-serving-cpu-memory_{context}"]
+= Monitoring Knative Serving revision CPU and memory usage
+
+You can use the {product-title} monitoring dashboards to view revision CPU and memory usage metrics for Knative Serving components.
+
+.Prerequisites
+
+* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+* You have installed the {ServerlessOperatorName}, as well as the Knative Serving component.
+* The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
+
+.Procedure
+
+. In the *Administrator* perspective, navigate to *Monitoring* -> *Dashboards*.
+. Select the *Knative Serving - Source CPU and Memory Usage* dashboard in the *Dashboard* drop-down list to view the following metrics:
+** Total CPU Usage (rate per minute)
+** Total Memory Usage (bytes)
+** Total Network I/O (rate per minute)
+** Total Network Errors (rate per minute)
+. Optional: You can filter this dashboard by *Namespace*, *Configuration*, or *Revision*, by selecting an option from the drop-down list.