mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Update monitoring docs
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
7d66de20b1
commit
33c9dc9117
@@ -2893,6 +2893,9 @@ Topics:
|
|||||||
# Serving
|
# Serving
|
||||||
- Name: Creating Knative Serving components in the Administrator perspective
|
- Name: Creating Knative Serving components in the Administrator perspective
|
||||||
File: serverless-cluster-admin-serving
|
File: serverless-cluster-admin-serving
|
||||||
|
# Monitoring
|
||||||
|
- Name: Monitoring serverless components
|
||||||
|
File: serverless-admin-monitoring
|
||||||
# Metering
|
# Metering
|
||||||
- Name: Using metering with OpenShift Serverless
|
- Name: Using metering with OpenShift Serverless
|
||||||
File: serverless-metering
|
File: serverless-metering
|
||||||
@@ -3010,12 +3013,6 @@ Topics:
|
|||||||
File: serverless-ossm-custom-domains
|
File: serverless-ossm-custom-domains
|
||||||
- Name: Configuring TLS for a custom domain using Service Mesh
|
- Name: Configuring TLS for a custom domain using Service Mesh
|
||||||
File: serverless-ossm-tls
|
File: serverless-ossm-tls
|
||||||
# Monitoring
|
|
||||||
- Name: Monitoring
|
|
||||||
Dir: monitoring
|
|
||||||
Topics:
|
|
||||||
- Name: Monitoring serverless components
|
|
||||||
File: serverless-monitoring
|
|
||||||
# Integrations
|
# Integrations
|
||||||
- Name: Integrations
|
- Name: Integrations
|
||||||
Dir: integrations
|
Dir: integrations
|
||||||
|
|||||||
BIN
images/knative-admin-health-status-dash.png
Normal file
BIN
images/knative-admin-health-status-dash.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 49 KiB |
@@ -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)
|
||||||
23
modules/serverless-admin-monitoring-eventing-cpu-memory.adoc
Normal file
23
modules/serverless-admin-monitoring-eventing-cpu-memory.adoc
Normal file
@@ -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)
|
||||||
35
modules/serverless-admin-monitoring-eventing-sources.adoc
Normal file
35
modules/serverless-admin-monitoring-eventing-sources.adoc
Normal file
@@ -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)
|
||||||
23
modules/serverless-admin-monitoring-health-status.adoc
Normal file
23
modules/serverless-admin-monitoring-health-status.adoc
Normal file
@@ -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.
|
||||||
24
modules/serverless-admin-monitoring-serving-cpu-memory.adoc
Normal file
24
modules/serverless-admin-monitoring-serving-cpu-memory.adoc
Normal file
@@ -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.
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
// 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]
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
// 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]
|
|
||||||
20
serverless/admin_guide/serverless-admin-monitoring.adoc
Normal file
20
serverless/admin_guide/serverless-admin-monitoring.adoc
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
include::modules/serverless-document-attributes.adoc[]
|
||||||
|
[id="serverless-admin-monitoring"]
|
||||||
|
= Monitoring serverless components
|
||||||
|
:context: serverless-admin-monitoring
|
||||||
|
include::modules/common-attributes.adoc[]
|
||||||
|
|
||||||
|
toc::[]
|
||||||
|
|
||||||
|
You can use {product-title} monitoring dashboards to view health checks and metrics for {ServerlessProductName} components.
|
||||||
|
|
||||||
|
// General monitoring for Serverless
|
||||||
|
include::modules/serverless-admin-monitoring-health-status.adoc[leveloffset=+1]
|
||||||
|
|
||||||
|
// Knative Serving dashboards
|
||||||
|
include::modules/serverless-admin-monitoring-serving-cpu-memory.adoc[leveloffset=+1]
|
||||||
|
|
||||||
|
// Knative Eventing dashboards
|
||||||
|
include::modules/serverless-admin-monitoring-eventing-cpu-memory.adoc[leveloffset=+1]
|
||||||
|
include::modules/serverless-admin-monitoring-eventing-sources.adoc[leveloffset=+1]
|
||||||
|
include::modules/serverless-admin-monitoring-eventing-broker-trigger.adoc[leveloffset=+1]
|
||||||
@@ -1 +0,0 @@
|
|||||||
../images
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
../modules
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
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]
|
|
||||||
Reference in New Issue
Block a user