Skip to content

Commit 19634ad

Browse files
gwynnemonahanopenshift-cherrypick-robot
authored andcommitted
OSDOCS-15288 [NETOBSERV] Line breaks for troubleshooting-network-observability.adoc and its includes
1 parent f16b70d commit 19634ad

5 files changed

+7
-1
lines changed

modules/troubleshooting-network-observability-loki-large-query-timeout.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
:_mod-docs-content-type: CONCEPT
22
[id="network-observability-troubleshooting-large-query-timeout_{context}"]
33
= Running a large query results in Loki errors
4+
45
When running large queries for a long time, Loki errors can occur, such as a `timeout` or `too many outstanding requests`. There is no complete corrective for this issue, but there are several ways to mitigate it:
56

67
Adapt your query to add an indexed filter::
@@ -12,7 +13,7 @@ Consider querying Prometheus rather than Loki::
1213
Prometheus is a better fit than Loki to query on large time ranges. However, whether or not you can use Prometheus instead of Loki depends on the use case. For example, queries on Prometheus are much faster than on Loki, and large time ranges do not impact performance. But Prometheus metrics do not contain as much information as flow logs in Loki. The Network Observability OpenShift web console automatically favors Prometheus over Loki if the query is compatible; otherwise, it defaults to Loki. If your query does not run against Prometheus, you can change some filters or aggregations to make the switch. In the OpenShift web console, you can force the use of Prometheus. An error message is displayed when incompatible queries fail, which can help you figure out which labels to change to make the query compatible. For example, changing a filter or an aggregation from *Resource* or *Pods* to *Owner*.
1314

1415
Consider using the FlowMetrics API to create your own metric::
15-
If the data that you need isn't available as a Prometheus metric, you can use the FlowMetrics API to create your own metric. For more information, see "FlowMetrics API Reference" and "Configuring custom metrics by using FlowMetric API".
16+
If the data that you need isn't available as a Prometheus metric, you can use the FlowMetrics API to create your own metric. For more information, see "FlowMetrics API Reference" and "Configuring custom metrics by using FlowMetric API".
1617

1718
Configure Loki to improve the query performance::
1819
+

modules/troubleshooting-network-observability-loki-resource-exhausted.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-troubleshooting-loki-resource-exhausted_{context}"]
77
= Troubleshooting Loki ResourceExhausted error
8+
89
Loki may return a `ResourceExhausted` error when network flow data sent by network observability exceeds the configured maximum message size. If you are using the Red{nbsp}Hat {loki-op}, this maximum message size is configured to 100 MiB.
910

1011
.Procedure

modules/troubleshooting-network-observability-loki-tenant-rate-limit.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-troubleshooting-loki-tenant-rate-limit_{context}"]
77
= LokiStack rate limit errors
8+
89
A rate-limit placed on the Loki tenant can result in potential temporary loss of data and a 429 error: `Per stream rate limit exceeded (limit:xMB/sec) while attempting to ingest for stream`. You might consider having an alert set to notify you of this error. For more information, see "Creating Loki rate limit alerts for the NetObserv dashboard" in the Additional resources of this section.
910

1011
You can update the LokiStack CRD with the `perStreamRateLimit` and `perStreamRateLimitBurst` specifications, as shown in the following procedure.

modules/troubleshooting-network-observability-must-gather.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-must-gather_{context}"]
77
= Using the must-gather tool
8+
89
You can use the must-gather tool to collect information about the Network Observability Operator resources and cluster-wide resources, such as pod logs, `FlowCollector`, and `webhook` configurations.
910

1011
.Procedure

observability/network_observability/troubleshooting-network-observability.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,13 @@ include::modules/troubleshooting-network-observability-query-loki-manually.adoc[
2525
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-resources-table_network_observability[Resource considerations]
2626
2727
include::modules/troubleshooting-network-observability-loki-resource-exhausted.adoc[leveloffset=+1]
28+
2829
include::modules/troubleshooting-network-observability-loki-empty-ring.adoc[leveloffset=+1]
2930

3031
== Resource troubleshooting
3132

3233
include::modules/troubleshooting-network-observability-loki-tenant-rate-limit.adoc[leveloffset=+1]
34+
3335
include::modules/troubleshooting-network-observability-loki-large-query-timeout.adoc[leveloffset=+1]
3436

3537
[role="_additional-resources"]

0 commit comments

Comments
 (0)