diff --git a/modules/network-observability-creating-metrics-network-events.adoc b/modules/network-observability-creating-metrics-network-events.adoc index 094b2e6f58c6..6d20cefaaa42 100644 --- a/modules/network-observability-creating-metrics-network-events.adoc +++ b/modules/network-observability-creating-metrics-network-events.adoc @@ -61,3 +61,8 @@ where: .Verification . In the web console, navigate to *Observe* -> *Dashboards* and scroll down to see the *Network Policy* tab. . You should begin seeing metrics filter in based on the metric you created along with the network policy specifications. + +[IMPORTANT] +==== +High cardinality can affect the memory usage of Prometheus. You can check if specific labels have high cardinality in the network flows format. See "Network Flows format reference". +==== diff --git a/modules/network-observability-health-rules-monitoring-and-alerting.adoc b/modules/network-observability-health-rules-monitoring-and-alerting.adoc index d3eaa8488fed..871fdb052042 100644 --- a/modules/network-observability-health-rules-monitoring-and-alerting.adoc +++ b/modules/network-observability-health-rules-monitoring-and-alerting.adoc @@ -2,7 +2,7 @@ // // * network_observability/network-observability-health-rules.adoc -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="network-observability-health-rules-monitoring-and-alerting_{context}"] = Network health monitoring and alerting rules @@ -47,4 +47,4 @@ For a complete list of rules and runbooks, see the link:https://github.com/opens == Rule dependencies and feature requirements The Network Observability Operator creates rules based on the features enabled in the `FlowCollector` custom resource (CR). -For example, packet drop-related rules are created only if the `PacketDrop` agent feature is enabled. Rules are built on metrics; if the required metrics are missing, configuration warnings might appear. Configure metrics in the `spec.processor.metrics.includeList` object of the `FlowCollector` resource. \ No newline at end of file +For example, packet drop-related rules are created only if the `PacketDrop` agent feature is enabled. Rules are built on metrics; if the required metrics are missing, configuration warnings might appear. Configure metrics in the `spec.processor.metrics.includeList` object of the `FlowCollector` resource. diff --git a/modules/network-observability-important-flowcollector-considerations.adoc b/modules/network-observability-important-flowcollector-considerations.adoc index 8ceb08a40241..89f2e28d9834 100644 --- a/modules/network-observability-important-flowcollector-considerations.adoc +++ b/modules/network-observability-important-flowcollector-considerations.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// network_observability/installing-operators.adoc +// * network_observability/installing-operators.adoc :_mod-docs-content-type: REFERENCE -[id="additional-resources_configuring-flow-collector-considerations_{context}"] -= Important Flow Collector configuration considerations +[id="network-observability-important-flowcollector-configuration-considerations_{context}"] += Important FlowCollector configuration considerations [role="_abstract"] Review essential `FlowCollector` configuration options before initial deployment to avoid pod disruptions caused by later reconfiguration. Key settings include Kafka integration, enriched flow data exports, SR-IOV traffic monitoring, and advanced tracking for DNS and packet drops. -When you create the `FlowCollector` instance, you can reconfigure it, but the pods are terminated and recreated again, which can be disruptive. +Once you create the `FlowCollector` instance, you can reconfigure it, but the pods are terminated and recreated again, which can be disruptive. Therefore, you can consider configuring the following options when creating the `FlowCollector` for the first time. diff --git a/modules/network-observability-kafka-option.adoc b/modules/network-observability-kafka-option.adoc index 6a4114083d27..1b6d191d3209 100644 --- a/modules/network-observability-kafka-option.adoc +++ b/modules/network-observability-kafka-option.adoc @@ -9,7 +9,7 @@ [role="_abstract"] The Kafka Operator is supported for large-scale environments. Kafka provides high-throughput and low-latency data feeds for forwarding network flow data in a more resilient, scalable way. -You can install the Kafka Operator as link:https://access.redhat.com/documentation/en-us/red_hat_amq_streams/2.2[Red Hat AMQ Streams] from the Operator Hub, just as the {loki-op} and Network Observability Operator were installed. Refer to "Configuring the FlowCollector resource with Kafka" to configure Kafka as a storage option. +You can install the Kafka Operator as Red Hat AMQ Streams from the Operator Hub, just as the {loki-op} and Network Observability Operator were installed. Refer to "Configuring the FlowCollector resource with Kafka" to configure Kafka as a storage option. [NOTE] ==== diff --git a/modules/network-observability-lokistack-ingestion-query.adoc b/modules/network-observability-lokistack-ingestion-query.adoc index ec747398b321..7d8e6a2a616f 100644 --- a/modules/network-observability-lokistack-ingestion-query.adoc +++ b/modules/network-observability-lokistack-ingestion-query.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * networking/network_observability/installing-operators.adoc -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="network-observability-lokistack-configuring-ingestion_{context}"] = LokiStack ingestion limits and health alerts diff --git a/modules/network-observability-packet-translation-overview.adoc b/modules/network-observability-packet-translation-overview.adoc index 3f0726bdb987..a24d2c9e8081 100644 --- a/modules/network-observability-packet-translation-overview.adoc +++ b/modules/network-observability-packet-translation-overview.adoc @@ -22,5 +22,4 @@ As network packets are processed, the eBPF hook enriches flow logs with metadata - Source Port - Destination Pod IP - Destination Port -- link:https://lwn.net/Articles/370152/#:~:text=A%20zone%20is%20simply%20a,to%20seperate%20conntrack%20defragmentation%20queues.[Conntrack Zone ID] - +- Conntrack Zone ID diff --git a/observability/network_observability/installing-operators.adoc b/observability/network_observability/installing-operators.adoc index 633c01ac3e09..402a7f3565d4 100644 --- a/observability/network_observability/installing-operators.adoc +++ b/observability/network_observability/installing-operators.adoc @@ -47,9 +47,7 @@ include::modules/network-observability-lokistack-ingestion-query.adoc[leveloffse include::modules/network-observability-operator-install.adoc[leveloffset=+1] -include::modules/network-observability-multitenancy.adoc[leveloffset=+1] - -include::modules/network-observability-important-flowcollector-considerations.adoc[leveloffset=+1] +include::modules/network-observability-important-flowcollector-considerations.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources @@ -65,6 +63,8 @@ include::modules/network-observability-important-flowcollector-considerations.ad * xref:../../observability/network_observability/troubleshooting-network-observability.adoc#controller-manager-pod-runs-out-of-memory_network-observability-troubleshooting[Troubleshooting network observability controller manager pod runs out of memory] * xref:../../observability/network_observability/understanding-network-observability-operator.adoc#network-observability-architecture_nw-network-observability-operator[Network observability architecture] +include::modules/network-observability-multitenancy.adoc[leveloffset=+1] + include::modules/network-observability-updating-migrating.adoc[leveloffset=+2] [role="_additional-resources"] @@ -75,6 +75,7 @@ include::modules/network-observability-kafka-option.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources +* link:https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.2[Red Hat AMQ Streams] * xref:../../observability/network_observability/configuring-operator.adoc#network-observability-flowcollector-kafka-config_network_observability[Configuring the FlowCollector resource with Kafka] include::modules/network-observability-operator-uninstall.adoc[leveloffset=+1] diff --git a/observability/network_observability/metrics-alerts-dashboards.adoc b/observability/network_observability/metrics-alerts-dashboards.adoc index dca962940f4c..a727d6666a74 100644 --- a/observability/network_observability/metrics-alerts-dashboards.adoc +++ b/observability/network_observability/metrics-alerts-dashboards.adoc @@ -25,6 +25,10 @@ include::modules/network-observability-configuring-custom-metrics-examples.adoc[ include::modules/network-observability-creating-metrics-network-events.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* xref:../../observability/network_observability/json-flows-format-reference.adoc#network-observability-flows-format_json_reference[Network Flows format reference] + include::modules/network-observability-flowmetrics-charts.adoc[leveloffset=+1] include::modules/network-observability-flowmetrics-charts-examples.adoc[leveloffset=+2] diff --git a/observability/network_observability/network-observability-health-rules.adoc b/observability/network_observability/network-observability-health-rules.adoc index 325fc2862acf..e277494e3c05 100644 --- a/observability/network_observability/network-observability-health-rules.adoc +++ b/observability/network_observability/network-observability-health-rules.adoc @@ -30,7 +30,6 @@ include::modules/network-observability-custom-health-rule-configuration.adoc[lev include::modules/network-observability-disable-predefined-rules.adoc[leveloffset=+1] - [role="_additional-resources"] == Additional resources * xref:../../observability/network_observability/network-observability-health-rules.adoc#network-observability-default-rules_network-observability-health-rules[List of default rules] diff --git a/observability/network_observability/network-observability-operator-release-notes.adoc b/observability/network_observability/network-observability-operator-release-notes.adoc index bf7b774d4316..8e47c5ca0cad 100644 --- a/observability/network_observability/network-observability-operator-release-notes.adoc +++ b/observability/network_observability/network-observability-operator-release-notes.adoc @@ -8,7 +8,7 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -Review new features, enhancements, fixed issues, and known issues for the Network Observability Operator. These release notes provide information to help you understand changes and security advisories in the latest operator release. +Find information about new features, security advisories, fixed issues, and known issues for the Network Observability Operator. Use these notes to stay informed about changes and performance enhancements in the latest version of the operator for {product-title}. The Network Observability Operator enables administrators to observe and analyze network traffic flows for {product-title} clusters. diff --git a/observability/network_observability/observing-network-traffic.adoc b/observability/network_observability/observing-network-traffic.adoc index b89be3d1871e..8e24e3e27e41 100644 --- a/observability/network_observability/observing-network-traffic.adoc +++ b/observability/network_observability/observing-network-traffic.adoc @@ -108,6 +108,10 @@ include::modules/network-observability-packet-translation-overview.adoc[leveloff include::modules/network-observability-packet-translation.adoc[leveloffset=+2] +[role="_additional-resources"] +.Additional resources +* link:https://lwn.net/Articles/370152/#:~:text=A%20zone%20is%20simply%20a,to%20seperate%20conntrack%20defragmentation%20queues.[Conntrack Zone ID] + include::modules/network-observability-working-with-udn.adoc[leveloffset=+2] [role="_additional-resources"]