Skip to content

Commit 50962dc

Browse files
authored
Merge pull request #64257 from skrthomas/OSDOCS-7660
OSDOCS-7660: Flow-based metrics enhancements
2 parents 107af8e + 9142dbc commit 50962dc

File tree

2 files changed

+22
-12
lines changed

2 files changed

+22
-12
lines changed

modules/network-observability-viewing-alerts.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@
88

99
You can access metrics about health and resource usage of the Network Observability Operator from the *Dashboards* page in the web console. A health alert banner that directs you to the dashboard can appear on the *Network Traffic* and *Home* pages in the event that an alert is triggered. Alerts are generated in the following cases:
1010

11-
* The *NetObservLokiError* alert occurs if the `flowlogs-pipeline` workload is dropping flows because of Loki errors, such as if the Loki ingestion rate limit has been reached.
12-
* The *NetObservNoFlows* alert occurs if no flows are ingested for a certain amount of time..Prerequisites
11+
* The `NetObservLokiError` alert occurs if the `flowlogs-pipeline` workload is dropping flows because of Loki errors, such as if the Loki ingestion rate limit has been reached.
12+
* The `NetObservNoFlows` alert occurs if no flows are ingested for a certain amount of time.
13+
14+
.Prerequisites
1315

1416
* You have the Network Observability Operator installed.
1517
* You have access to the cluster as a user with the `cluster-admin` role or with view permissions for all projects.

networking/network_observability/network-observability-overview.adoc

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,31 @@ The Network Observability Operator provides the Flow Collector API custom resour
3232
{product-title} console integration offers overview, topology view and traffic flow tables.
3333

3434
[id="network-observability-dashboards"]
35-
=== Network Observability metrics
35+
=== Network Observability metrics dashboards
3636

37-
The {product-title} console offers the *Overview* tab which displays the overall aggregated metrics of the network traffic flow on the cluster. The information can be displayed by node, namespace, owner, pod, and service. Filters and display options can further refine the metrics.
37+
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. Filters and display options can further refine the metrics.
3838

3939
In *Observe* -> *Dashboards*, the *Netobserv* dashboard provides a quick overview of the network flows in your {product-title} cluster. You can view distillations of the network traffic metrics in the following categories:
4040

41-
* *Top flow rates per source and destination namespaces (1-min rates)*
42-
* *Top byte rates emitted per source and destination nodes (1-min rates)*
43-
* *Top byte rates received per source and destination nodes (1-min rates)*
44-
* *Top byte rates emitted per source and destination workloads (1-min rates)*
45-
* *Top byte rates received per source and destination workloads (1-min rates)*
46-
* *Top packet rates emitted per source and destination workloads (1-min rates)*
47-
* *Top packet rates received per source and destination workloads (1-min rates)*
41+
* *Top byte rates received per source and destination nodes*
42+
* *Top byte rates received per source and destination namespaces*
43+
* *Top byte rates received per source and destination workloads*
4844

45+
*Infrastructure* and *Application* metrics are shown in a split-view for namespace and workloads.
4946
You can configure the `FlowCollector` `spec.processor.metrics` to add or remove metrics by changing the `ignoreTags` list. For more information about available tags, see the xref:../../networking/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference]
5047

51-
Also in *Observe* -> *Dashboards*, the *Netobserv/Health* dashboard provides metrics about the health of the Operator.
48+
Also in *Observe* -> *Dashboards*, the *Netobserv/Health* dashboard provides metrics about the health of the Operator in the following categories.
49+
50+
* *Flows*
51+
* *Flows Overhead*
52+
* *Top flow rates per source and destination nodes*
53+
* *Top flow rates per source and destination namespaces*
54+
* *Top flow rates per source and destination workloads*
55+
* *Agents*
56+
* *Processor*
57+
* *Operator*
58+
59+
*Infrastructure* and *Application* metrics are shown in a split-view for namespace and workloads.
5260

5361
[id="network-observability-topology-views"]
5462
=== Network Observability topology views

0 commit comments

Comments
 (0)