Skip to content

Commit 689aae1

Browse files
authored
Merge pull request #103635 from openshift-cherrypick-robot/cherry-pick-103480-to-enterprise-4.16
[enterprise-4.16] OSDOCS-17454 [NETOBSERV] Module short descriptions for network-observability-operator-monitoring.adoc
2 parents 0c0cb48 + 299f6e0 commit 689aae1

6 files changed

+20
-4
lines changed

modules/network-observability-disabling-health-alerts.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
[id="network-observability-disable-alerts_{context}"]
77
= Disabling health alerts
88

9-
You can opt out of health alerting by editing the `FlowCollector` resource:
9+
[role="_abstract"]
10+
Disable specific health alerts, such as `NetObservLokiError` or `NetObservNoFlows`, by editing the `FlowCollector` resource and using the `spec.processor.metrics.disableAlerts` specification.
11+
12+
.Procedure
1013

1114
. In the web console, navigate to *Operators* -> *Installed Operators*.
1215
. Under the *Provided APIs* heading for the *NetObserv Operator*, select *Flow Collector*.

modules/network-observability-ebpf-agent-alert.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
[id="network-observability-netobserv-dashboard-ebpf-agent-alerts_{context}"]
66
= Using the eBPF agent alert
77

8-
An alert, `NetObservAgentFlowsDropped`, is triggered when the network observability eBPF agent hashmap table is full or when the capacity limiter is triggered. If you see this alert, consider increasing the `cacheMaxFlows` in the `FlowCollector`, as shown in the following example.
8+
[role="_abstract"]
9+
Resolve the `NetObservAgentFlowsDropped` alert, which occurs when the eBPF agent hashmap is full, by increasing the `spec.agent.ebpf.cacheMaxFlows` value in the `FlowCollector` custom resource.
10+
11+
An alert, `NetObservAgentFlowsDropped`, is also triggered when the capacity limiter is triggered. If you see this alert, consider increasing the `cacheMaxFlows` in the `FlowCollector`, as shown in the following example.
912

1013
[NOTE]
1114
====

modules/network-observability-health-alerts-overview.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
[id="network-observability-health-alert-overview_{context}"]
77
= Health alerts
88

9+
[role="_abstract"]
10+
Understand the health alerts generated by the Network Observability Operator, which trigger banners when conditions like Loki ingestion errors, zero flow ingestion, or dropped eBPF flows occur.
11+
912
A health alert banner that directs you to the dashboard can appear on the *Network Traffic* and *Home* pages if an alert is triggered. Alerts are generated in the following cases:
1013

1114
* 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.

modules/network-observability-health-dashboard-overview.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
[id="network-observability-health-dashboard-overview_{context}"]
77
= Health dashboards
88

9-
Metrics about health and resource usage of the Network Observability Operator are located in the *Observe* -> *Dashboards* page in the web console. You can view metrics about the health of the Operator in the following categories:
9+
[role="_abstract"]
10+
View the Network Observability Operator health dashboards in the {product-title} web console to monitor the health status, resource usage, and internal statistics of the operator and its components.
11+
12+
Metrics are located in the *Observe* -> *Dashboards* page in the {product-title} web console. You can view metrics about the health of the Network Observability Operator in the following categories:
1013

1114
* *Flows per second*
1215
* *Sampling*

modules/network-observability-rate-limit-alert.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
[id="network-observability-netobserv-dashboard-rate-limit-alerts_{context}"]
66
= Creating Loki rate limit alerts for the NetObserv dashboard
77

8+
[role="_abstract"]
9+
Create a custom `AlertingRule` resource based on Loki metrics to monitor for and trigger alerts when the Loki ingestion rate limits are reached, indicated by HTTP 429 errors.
10+
811
You can create custom alerting rules for the *Netobserv* dashboard metrics to trigger alerts when Loki rate limits have been reached.
912

1013
.Prerequisites

modules/network-observability-viewing-alerts.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
[id="network-observability-dashboard-view_{context}"]
77
= Viewing health information
88

9-
You can access metrics about health and resource usage of the Network Observability Operator from the *Dashboards* page in the web console.
9+
[role="_abstract"]
10+
View the *Netobserv/Health* dashboard within the {product-title} web console to monitor the health status and resource usage of the Network Observability Operator and its components.
1011

1112
.Prerequisites
1213

0 commit comments

Comments
 (0)