Skip to content

Commit 73b3d9e

Browse files
committed
OSDOCS-15282 [NETOBSERV] Line breaks for metrics-alerts-dashboards.adoc and its includes
1 parent 601a9dc commit 73b3d9e

7 files changed

+21
-14
lines changed

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-configuring-custom-metrics_{context}"]
77
= Configuring custom metrics by using FlowMetric API
8+
89
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.
910

1011
.Procedure
1112

1213
. In the web console, navigate to *Operators* -> *Installed Operators*.
1314
. In the *Provided APIs* heading for the *NetObserv Operator*, select *FlowMetric*.
14-
. In the *Project:* dropdown list, select the project of the Network Observability Operator instance.
15+
. In the *Project:* dropdown list, select the project of the Network Observability Operator instance.
1516
. Click *Create FlowMetric*.
1617
. Configure the `FlowMetric` resource, similar to the following sample configurations:
1718
+
@@ -36,9 +37,9 @@ spec:
3637
matchType: Absence
3738
----
3839
<1> The `FlowMetric` resources need to be created in the namespace defined in the `FlowCollector` `spec.namespace`, which is `netobserv` by default.
39-
<2> The name of the Prometheus metric, which in the web console appears with the prefix `netobserv-<metricName>`.
40+
<2> The name of the Prometheus metric, which in the web console appears with the prefix `netobserv-<metricName>`.
4041
<3> The `type` specifies the type of metric. The `Counter` `type` is useful for counting bytes or packets.
41-
<4> The direction of traffic to capture. If not specified, both ingress and egress are captured, which can lead to duplicated counts.
42+
<4> The direction of traffic to capture. If not specified, both ingress and egress are captured, which can lead to duplicated counts.
4243
<5> Labels define what the metrics look like and the relationship between the different entities and also define the metrics cardinality. For example, `SrcK8S_Name` is a high cardinality metric.
4344
<6> Refines results based on the listed criteria. In this example, selecting only the cluster external traffic is done by matching only flows where `SrcSubnetLabel` is absent. This assumes the subnet labels feature is enabled (via `spec.processor.subnetLabels`), which is done by default.
4445

@@ -78,7 +79,7 @@ spec:
7879

7980
.Verification
8081
. Once the pods refresh, navigate to *Observe* -> *Metrics*.
81-
. In the *Expression* field, you can type the metric name to view the corresponding result.
82+
. In the *Expression* field, you can type the metric name to view the corresponding result.
8283
====
8384

8485

modules/network-observability-custom-metrics.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@
55
:_mod-docs-content-type: CONCEPT
66
[id="network-observability-custom-metrics_{context}"]
77
= Custom metrics
8-
You can create custom metrics out of the flowlogs data using the `FlowMetric` API. In every flowlogs data that is collected, there are a number of 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.
8+
9+
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.

modules/network-observability-flowmetrics-charts.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-custom-charts-flowmetrics_{context}"]
77
= Configuring custom charts using FlowMetric API
8+
89
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.
910

1011
.Procedure
1112
. In the web console, navigate to *Operators* -> *Installed Operators*.
1213
. In the *Provided APIs* heading for the *NetObserv Operator*, select *FlowMetric*.
13-
. In the *Project:* dropdown list, select the project of the Network Observability Operator instance.
14+
. In the *Project:* dropdown list, select the project of the Network Observability Operator instance.
1415
. Click *Create FlowMetric*.
15-
. Configure the `FlowMetric` resource, similar to the following sample configurations:
16+
. Configure the `FlowMetric` resource, similar to the following sample configurations:
1617

1718
.Chart for tracking ingress bytes received from cluster external sources
1819
[%collapsible]

modules/network-observability-includelist-example.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
:_mod-docs-content-type: PROCEDURE
55
[id="network-observability-netobserv-dashboard-high-traffic-alert_{context}"]
66
= Creating alerts
7+
78
You can create custom alerting rules for the Netobserv dashboard metrics to trigger alerts when some defined conditions are met.
89

910
.Prerequisites

modules/network-observability-metrics-names.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@
55
:_mod-docs-content-type: REFERENCE
66
[id="network-observability-metrics_{context}"]
77
= Network Observability metrics
8+
89
You can also create alerts by using the `includeList` metrics in Prometheus rules, as shown in the example "Creating alerts".
910

1011
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:
1112

1213
includeList metrics names::
13-
Names followed by an asterisk `*` are enabled by default.
14+
Names followed by an asterisk `*` are enabled by default.
1415

1516
* `namespace_egress_bytes_total`
1617
* `namespace_egress_packets_total`

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-tcp-flag-syn-flood_{context}"]
77
= Detecting SYN flooding using the FlowMetric API and TCP flags
8-
You can create an `AlertingRule` resouce to alert for SYN flooding.
8+
9+
You can create an `AlertingRule` resouce to alert for SYN flooding.
910

1011
.Procedure
1112
. In the web console, navigate to *Operators* -> *Installed Operators*.
1213
. In the *Provided APIs* heading for the *NetObserv Operator*, select *FlowMetric*.
13-
. In the *Project* dropdown list, select the project of the Network Observability Operator instance.
14+
. In the *Project* dropdown list, select the project of the Network Observability Operator instance.
1415
. Click *Create FlowMetric*.
15-
. Create `FlowMetric` resources to add the following configurations:
16+
. Create `FlowMetric` resources to add the following configurations:
1617
+
1718
.Configuration counting flows per destination host and resource, with TCP flags
1819
[source,yaml]
@@ -81,5 +82,5 @@ metadata:
8182
.Verification
8283
. In the web console, click *Manage Columns* in the *Network Traffic* table view and click *TCP flags*.
8384
. In the *Network Traffic* table view, filter on *TCP protocol SYN TCPFlag*. A large number of flows with the same *byteSize* indicates a SYN flood.
84-
. Go to *Observe* -> *Alerting* and select the *Alerting Rules* tab.
85-
. Filter on *netobserv-synflood-in alert*. The alert should fire when SYN flooding occurs.
85+
. Go to *Observe* -> *Alerting* and select the *Alerting Rules* tab.
86+
. Filter on *netobserv-synflood-in alert*. The alert should fire when SYN flooding occurs.

modules/network-observability-viewing-dashboards.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-viewing-dashboards_{context}"]
77
= Viewing Network Observability metrics dashboards
8+
89
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.
910

1011
.Procedure
@@ -16,7 +17,7 @@ On the *Overview* tab in the {product-title} console, you can view the overall a
1617
* *DNS*
1718
* *RTT*
1819

19-
. Select the *Netobserv/Health* dashboard.
20+
. Select the *Netobserv/Health* dashboard.
2021
. View metrics about the health of the Operator in the following categories, with each having the subset per node, namespace, source, and destination.
2122

2223
* *Flows*

0 commit comments

Comments
 (0)