diff --git a/_topic_map.yml b/_topic_map.yml index 026bc71649..0dbe0e4c44 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -2685,6 +2685,12 @@ Topics: File: serverless-ossm-jwt - Name: Using custom domains for Knative services with Service Mesh File: serverless-ossm-custom-domains +# Monitoring +- Name: Monitoring + Dir: monitoring + Topics: + - Name: Monitoring serverless components + File: serverless-monitoring # Metering - Name: Using metering with OpenShift Serverless File: serverless-metering diff --git a/images/knative-health-status-dash.png b/images/knative-health-status-dash.png new file mode 100644 index 0000000000..08777f160c Binary files /dev/null and b/images/knative-health-status-dash.png differ diff --git a/images/knative-serving-cpu-memory-dash.png b/images/knative-serving-cpu-memory-dash.png new file mode 100644 index 0000000000..988d9d7dc9 Binary files /dev/null and b/images/knative-serving-cpu-memory-dash.png differ diff --git a/modules/serverless-monitoring-health-status.adoc b/modules/serverless-monitoring-health-status.adoc new file mode 100644 index 0000000000..fa3cc5e1a0 --- /dev/null +++ b/modules/serverless-monitoring-health-status.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * /serverless/monitoring/serverless-monitoring.adoc + +[id="serverless-monitoring-health-status"] += Monitoring serverless components overall health status + +You can use the {product-title} monitoring dashboards to view the overall health status of Knative Serving and Eventing. + +.Prerequisites + +* You have installed {ServerlessProductName}. +* The {product-title} monitoring stack is enabled. +* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console. + +.Procedure + +. In the *Administrator* perspective, navigate to *Monitoring* -> *Dashboards*. +. Select the *Knative Health Status* dashboard to view the overall health status of Knative Serving and Eventing. ++ +image::knative-health-status-dash.png[Knative Health Status dashboard] diff --git a/modules/serverless-monitoring-serving-cpu-memory.adoc b/modules/serverless-monitoring-serving-cpu-memory.adoc new file mode 100644 index 0000000000..b636beea38 --- /dev/null +++ b/modules/serverless-monitoring-serving-cpu-memory.adoc @@ -0,0 +1,22 @@ +// Module included in the following assemblies: +// +// * /serverless/monitoring/serverless-monitoring.adoc + +[id="serverless-monitoring-serving-cpu-memory"] += 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 installed {ServerlessProductName}. +* The {product-title} monitoring stack is enabled. +* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console. + +.Procedure + +. In the *Administrator* perspective, navigate to *Monitoring* -> *Dashboards*. +. Select the *Knative Serving - Revision CPU and Memory Usage* dashboard to view metrics for Knative service revisions. +. Optional: You can filter this dashboard by *Namespace*, *Configuration*, or *Revision*, by using the drop-down selections. ++ +image::knative-serving-cpu-memory-dash.png[Knative Serving Revision CPU and Memory Usage dashboard] diff --git a/serverless/monitoring/images b/serverless/monitoring/images new file mode 120000 index 0000000000..5e67573196 --- /dev/null +++ b/serverless/monitoring/images @@ -0,0 +1 @@ +../images \ No newline at end of file diff --git a/serverless/monitoring/modules b/serverless/monitoring/modules new file mode 120000 index 0000000000..464b823aca --- /dev/null +++ b/serverless/monitoring/modules @@ -0,0 +1 @@ +../modules \ No newline at end of file diff --git a/serverless/monitoring/serverless-monitoring.adoc b/serverless/monitoring/serverless-monitoring.adoc new file mode 100644 index 0000000000..c416a7388c --- /dev/null +++ b/serverless/monitoring/serverless-monitoring.adoc @@ -0,0 +1,15 @@ +// This assembly is included in the following assemblies: +// +// +include::modules/serverless-document-attributes.adoc[] +[id="serverless-monitoring"] += Monitoring serverless components +:context: serverless-monitoring +include::modules/common-attributes.adoc[] + +toc::[] + +You can use {product-title} monitoring dashboards to view health checks and metrics for {ServerlessProductName} components. + +include::modules/serverless-monitoring-health-status.adoc[leveloffset=+1] +include::modules/serverless-monitoring-serving-cpu-memory.adoc[leveloffset=+1]