Merge pull request #103544 from gwynnemonahan/manual-cherry-pick-enterprise-4-16-OSDOCS-17453

[enterprise-4.16] OSDOCS-17453 [NETOBSERV] Module short descriptions for metrics-alerts-dashboards.adoc

Author: jeana-redhat

modules/network-observability-configuring-custom-metrics.adoc

@@ -6,7 +6,8 @@
 [id="network-observability-configuring-custom-metrics_{context}"]
 = Configuring custom metrics by using FlowMetric API
 
-You can configure the `FlowMetric` API to create custom metrics by using flowlogs data fields as Prometheus labels. You can add multiple `FlowMetric` resources to a project to see multiple dashboard views.
+[role="_abstract"]
+Configure the `FlowMetric` API to create custom Prometheus metrics by mapping flow log fields as labels to meet specific monitoring needs.
 
 .Procedure
 
@@ -17,8 +18,7 @@ You can configure the `FlowMetric` API to create custom metrics by using flowlog
 . Configure the `FlowMetric` resource, similar to the following sample configurations:
 +
 .Generate a metric that tracks ingress bytes received from cluster external sources
-[%collapsible]
-====
+
 [source,yaml]
 ----
 apiVersion: flows.netobserv.io/v1alpha1
@@ -46,11 +46,9 @@ spec:
 .Verification
 . Once the pods refresh, navigate to *Observe* -> *Metrics*.
 . In the *Expression* field, type the metric name to view the corresponding result. You can also enter an expression, such as `topk(5, sum(rate(netobserv_cluster_external_ingress_bytes_total{DstK8S_Namespace="my-namespace"}[2m])) by (DstK8S_HostName, DstK8S_OwnerName, DstK8S_OwnerType))`
-====
 +
 .Show RTT latency for cluster external ingress traffic
-[%collapsible]
-====
+
 [source,yaml]
 ----
 apiVersion: flows.netobserv.io/v1alpha1
@@ -80,7 +78,6 @@ spec:
 .Verification
 . Once the pods refresh, navigate to *Observe* -> *Metrics*.
 . In the *Expression* field, you can type the metric name to view the corresponding result.
-====
 
 
 

modules/network-observability-custom-metrics.adoc

@@ -6,4 +6,7 @@
 [id="network-observability-custom-metrics_{context}"]
 = Custom metrics
 
-You can create custom metrics out of the flowlogs data using the `FlowMetric` API. In every flowlogs data that is collected, there are several fields labeled per log, such as source name and destination name. These fields can be leveraged as Prometheus labels to enable the customization of cluster information on your dashboard.
+[role="_abstract"]
+Define custom metrics from flowlog data using the `FlowMetric` API, leveraging log fields as Prometheus labels to customize dashboard information and monitor specific cluster data.
+
+In every flowlogs data that is collected, there are several fields labeled per log, such as source name and destination name. These fields can be leveraged as Prometheus labels to enable the customization of cluster information on your dashboard.

modules/network-observability-flowmetrics-charts.adoc

@@ -6,18 +6,19 @@
 [id="network-observability-custom-charts-flowmetrics_{context}"]
 = Configuring custom charts using FlowMetric API
 
-You can generate charts for dashboards in the {product-title} web console, which you can view as an administrator in the *Dashboard* menu by defining the `charts` section of the `FlowMetric` resource.
+[role="_abstract"]
+Generate custom charts for {product-title} web console dashboards by defining the charts section of the `FlowMetric` custom resource.
+
+You can view custom charts as an administrator in the *Dashboard* menu.
 
 .Procedure
 . In the web console, navigate to *Operators* -> *Installed Operators*.
 . In the *Provided APIs* heading for the *NetObserv Operator*, select *FlowMetric*.
 . In the *Project:*  dropdown list, select the project of the Network Observability Operator instance.
 . Click *Create FlowMetric*.
 . Configure the `FlowMetric` resource, similar to the following sample configurations:
-
++
 .Chart for tracking ingress bytes received from cluster external sources
-[%collapsible]
-====
 [source,yaml]
 ----
 apiVersion: flows.netobserv.io/v1alpha1
@@ -54,11 +55,8 @@ metadata:
 * A timeseries graph showing the same metric per destination workload
 
 For more information about the query language, refer to the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus documentation].
-====
 
 .Chart for RTT latency for cluster external ingress traffic
-[%collapsible]
-====
 [source,yaml]
 ----
 apiVersion: flows.netobserv.io/v1alpha1
@@ -110,4 +108,4 @@ promQL: "(sum(rate($METRIC_sum{DstK8S_Namespace!=\"\"}[2m])) by (DstK8S_Namespac
 . Search for the *NetObserv / Main* dashboard. View the new panel under the *NetObserv / Main* dashboard, or optionally a dashboard name that you create.
 
 For more information about the query language, refer to the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus documentation].
-====
+

modules/network-observability-includelist-example.adoc

@@ -5,7 +5,8 @@
 [id="network-observability-netobserv-dashboard-high-traffic-alert_{context}"]
 = Creating alerts
 
-You can create custom alerting rules for the Netobserv dashboard metrics to trigger alerts when some defined conditions are met.
+[role="_abstract"]
+Create custom `AlertingRule` resources based on `Netobserv` dashboard metrics to define conditions that trigger alerts in the {product-title} console.
 
 .Prerequisites
 

modules/network-observability-metrics-names.adoc

@@ -6,6 +6,11 @@
 [id="network-observability-metrics_{context}"]
 = Network observability metrics
 
+[role="_abstract"]
+Review the comprehensive list of network observability metrics, prefixed by `netobserv_`, which you can configure in the `FlowCollector` resource and use to monitor traffic and create Prometheus alerts.
+
+Metrics generated by the `flowlogs-pipeline` are configurable in the `spec.processor.metrics.includeList` of the `FlowCollector` custom resource to add or remove metrics.
+
 You can also create alerts by using the `includeList` metrics in Prometheus rules, as shown in the example "Creating alerts".
 
 When looking for these metrics in Prometheus, such as in the Console through *Observe* -> *Metrics*, or when defining alerts, all the metrics names are prefixed with `netobserv_`. For example, `netobserv_namespace_flows_total`. Available metrics names are as follows:

modules/network-observability-predefined-metrics.adoc

@@ -2,8 +2,12 @@
 //
 // network_observability/metrics-alerts-dashboards.adoc
 
+////
 :_mod-docs-content-type: CONCEPT
 [id="network-observability-predefined-metrics_{context}"]
 = Predefined metrics
 
-Metrics generated by the `flowlogs-pipeline` are configurable in the `spec.processor.metrics.includeList` of the `FlowCollector` custom resource to add or remove metrics. 
+Metrics generated by the `flowlogs-pipeline` are configurable in the `spec.processor.metrics.includeList` of the `FlowCollector` custom resource to add or remove metrics.
+////
+
+//moved to network-observability-metrics-names.adoc

modules/network-observability-tcp-flag-syn-flood.adoc

@@ -6,7 +6,8 @@
 [id="network-observability-tcp-flag-syn-flood_{context}"]
 = Detecting SYN flooding using the FlowMetric API and TCP flags
 
-You can create an `AlertingRule` resouce to alert for SYN flooding.
+[role="_abstract"]
+Deploy a custom `AlertingRule` and `FlowMetric` configuration to monitor TCP flags, enabling real-time detection and alerting for SYN flooding attacks on the cluster.
 
 .Procedure
 . In the web console, navigate to *Operators* -> *Installed Operators*.

modules/network-observability-viewing-dashboards.adoc

@@ -6,7 +6,8 @@
 [id="network-observability-viewing-dashboards_{context}"]
 = Viewing network observability metrics dashboards
 
-On the *Overview* tab in the {product-title} console, you can view the overall aggregated metrics of the network traffic flow on the cluster. You can choose to display the information by node, namespace, owner, pod, and service. You can also use filters and display options to further refine the metrics.
+[role="_abstract"]
+View network observability metrics dashboards using the *Overview* tab in the {product-title} console to monitor overall traffic flow and system health, with options to filter metrics by node, namespace, owner, pod, and service.
 
 .Procedure
 . In the web console *Observe* -> *Dashboards*, select the *Netobserv* dashboard.