Skip to content

[enterprise-4.21] OSDOCS-18368 [NETOBSERV] Health rules and other fixes from 1.11 #107342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lahinson merged 1 commit into from
Feb 25, 2026
Merged

[enterprise-4.21] OSDOCS-18368 [NETOBSERV] Health rules and other fixes from 1.11 #107342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/network-observability-disable-predefined-rules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
= Disable predefined rules

[role="_abstract"]
Rule templates can be disabled in the `spec.processor.metrics.disableAlerts` field of the `FlowCollector` custom resource (CR). This setting accepts a list of rule template names. For a list of alert template names, see: "List of default rules".
Rule templates can be disabled in the `spec.processor.metrics.disableAlerts` field of the `FlowCollector` custom resource (CR). This setting accepts a list of rule template names. For a list of alert template names, see "List of default rules".

If a template is disabled and overridden in the `spec.processor.metrics.healthRules` field, the disable setting takes precedence and the alert rule is not created.
4 changes: 2 additions & 2 deletions modules/network-observability-health-rule-structure-customization.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
[role="_abstract"]
Health rules in the Network Observability Operator are defined using rule templates and variants in the `spec.processor.metrics.healthRules` object of the `FlowCollector` custom resource (CR). You can customize the default templates and variants for flexible, fine-grained alerting.

For each template, you can define a list of variants, each with their own thresholds and grouping configurations. For more information, see the "List of default alert templates".
For each template, you can define a list of variants, each with their own thresholds and grouping configurations. For more information, see "List of default alert templates".

Here is an example:
The following example shows an alert:

[source,yaml]
----
Expand Down
10 changes: 5 additions & 5 deletions modules/network-observability-health-rules-promql-expressions-metadata.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,11 @@ The `netobserv_io_network_health` annotation is a JSON string consisting of the
| List of strings
| One or more labels that hold node names. When provided, the alert appears under the *Nodes* tab.

|`workloadLabels`:
|`workloadLabels`
| List of strings
| One or more labels that hold owner/workload names. When provided alongside with `kindLabels`, the alert will show up under the "Owners" tab.

|`kindLabels`:
|`kindLabels`
| List of strings
| One or more labels that hold owner/workload kinds. When provided alongside with `workloadLabels`, the alert will show up under the "Owners" tab.

Expand All @@ -157,6 +157,8 @@ The `netobserv_io_network_health` annotation is a JSON string consisting of the
| Information related to the link to the *Network Traffic* page, for URL building. Some filters will be set automatically, such as the `node` or `namespace` filter.
|===

The `namespaceLabels` and `nodeLabels` are mutually exclusive. If neither is provided, the alert appears under the *Global* tab.

.`trafficLink` fields
[cols="1,3",options="header"]
|===
Expand All @@ -171,6 +173,4 @@ The `netobserv_io_network_health` annotation is a JSON string consisting of the

| `filterDestination`
| Whether the filter should target the destination of the traffic instead of the source (`true` or `false`).
|===

The `namespaceLabels` and `nodeLabels` are mutually exclusive. If neither is provided, the alert appears under the *Global* tab.
|===
2 changes: 1 addition & 1 deletion observability/network_observability/network-observability-health-rules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ include::modules/network-observability-disable-predefined-rules.adoc[leveloffset


[role="_additional-resources"]
.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]
* xref:../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-viewing-dashboards_metrics-dashboards-alerts[Viewing network observability metrics dashboards]
* xref:../../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-netobserv-dashboard-high-traffic-alert_metrics-dashboards-alerts[Creating alerts]
Expand Down
16 changes: 1 addition & 15 deletions observability/network_observability/network-observability-per-tenant-model.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,4 @@ include::modules/network-observability-per-tenant-flowcollector-slice-api-refere
[role="_additional-resources"]
== Additional resources

* xref:../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[FlowCollector API reference]

////
* drafty draft to get words on the page and an overall sense of new feature.
* may not stay own assembly; may need to be slotted somewhere. but it also might make sense to keep it as its own assembly so as not to make the observing-network-traffic.adoc assembly even larger.
* worth considering collecting FlowCollector info and putting it all together, except for the API since that is auto-generated.
* should enable, configure, disable be leveloffset=+2?
* fix titles and URLs once content is structured/organized
////






* xref:../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[FlowCollector API reference]