OBSDOCS-1801: Loki - Adjust Queries for both OTEL and ViaQ by theashiot · Pull Request #94828 · openshift/openshift-docs

theashiot · 2025-06-16T18:54:23Z

Version(s): 6.3

Issue: https://issues.redhat.com/browse/OBSDOCS-1801

Link to docs preview:
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/custom-logging-alerts.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/default-logging-alerts.html

QE review:

QE has approved this change.

Additional information:

openshift-ci-robot · 2025-06-16T18:54:27Z

@theashiot: This pull request references OBSDOCS-1801 which is a valid jira issue.

Details

In response to this:

Version(s): 6.0+

Issue: https://issues.redhat.com/browse/OBSDOCS-1801

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2025-06-16T19:04:03Z

🤖 Wed Jul 16 10:12:12 - Prow CI generated the docs preview:

https://94828--ocpdocs-pr.netlify.app/
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/custom-logging-alerts.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/default-logging-alerts.html

openshift-ci-robot · 2025-06-23T15:43:52Z

@theashiot: This pull request references OBSDOCS-1801 which is a valid jira issue.

Details

In response to this:

Version(s): 6.0+

Issue: https://issues.redhat.com/browse/OBSDOCS-1801

Link to docs preview:
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/custom-logging-alerts.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/default-logging-alerts.html

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

xperimental

Had a first look at it. I'll give it a more thorough read tomorrow.

xperimental · 2025-06-30T16:07:19Z

 | Tenant type    | Valid namespaces for `AlertingRule` CRs
-| application    |
 | audit          | `openshift-logging`
 | infrastructure | `openshift-/\*`, `kube-/\*`, `default`


This does not seem to parse well. The \ and / are not meant to be in the output. To me it looks as if we can just use openshift-* and kube-*.

theashiot · 2025-07-07T13:00:23Z

Thanks, @xperimental for the review! I've fixed the issues with rendering.

best,
ashwin

xperimental

Sorry for taking a while for the second review...

xperimental · 2025-07-08T11:21:50Z

-| application    |
 | audit          | `openshift-logging`
-| infrastructure | `openshift-/\*`, `kube-/\*`, `default`
+| infrastructure | `openshift-\*`, `kube-*`, `default`


Suggested change

| infrastructure | `openshift-\*`, `kube-*`, `default`

| infrastructure | `openshift-*`, `kube-*`, `default`

The "\" is an escape sequence character. This renders as:

openshift-*, kube-*, default

Ok, I'm not sure what it is escaping then, because if it's the * we should need one for the second occurrence as well. I'm also not sure if the current preview is up-to-date with the state of the PR.

xperimental · 2025-07-08T11:22:01Z

 <1> The namespace where this `AlertingRule` CR is created must have a label matching the LokiStack `spec.rules.namespaceSelector` definition.
 <2> The `labels` block must match the LokiStack `spec.rules.selector` definition.
-<3> `AlertingRule` CRs for `infrastructure` tenants are only supported in the `openshift-\*`, `kube-\*`, or `default` namespaces.
+<3> `AlertingRule` CRs for `infrastructure` tenants are only supported in the `openshift-\*`, `kube-*`, or `default` namespaces.


Suggested change

<3> `AlertingRule` CRs for `infrastructure` tenants are only supported in the `openshift-\*`, `kube-*`, or `default` namespaces.

<3> `AlertingRule` CRs for `infrastructure` tenants are only supported in the `openshift-*`, `kube-*`, or `default` namespaces.

same as above

xperimental

Fine for me.

theashiot · 2025-07-09T17:20:15Z

Thanks, @xperimental for the review!

theashiot · 2025-07-09T17:20:20Z

Hi @anpingli, @kabirbhartiRH, @QiaolingTang, can you please provide a QE review for the changes?

thanks,
ashwin

theashiot · 2025-07-10T19:14:20Z

Hi @anpingli, @kabirbhartiRH, @QiaolingTang, can you please provide a QE review for the changes?

thanks,
ashwin

anpingli · 2025-07-11T07:58:27Z

 ----
 <1> Enable Loki alerting and recording rules in your cluster.
-<2> Add a custom label that can be added to namespaces where you want to enable the use of logging alerts and metrics.
+<2> Specify the selector for the alerting and recording resources if you have deployed many `LokiStack` CRs in a cluster.


We should remove 'if you have deployed many LokiStack CRs in a cluster'. this label is required too when only one lokiStack is deployed.

anpingli · 2025-07-11T08:11:30Z

+    namespaceSelector: #<4>
      matchLabels:
-        openshift.io/<label_name>: "true" <3>
+        openshift.io/<label_name>: "true" #<5>


I think we can use same example: <label_name>: "true".

anpingli · 2025-07-11T09:09:22Z

 = Logging collector alerts

-In logging 5.8 and later versions, the following alerts are generated by the {clo}. You can view these alerts in the {ocp-product-title} web console.
+The following alerts are generated by the {clo}. You can view these alerts in the {ocp-product-title} web console.


CollectorHighErrorRate and CollectorVeryHighErrorRate is for 5.x only.

This file is not included so the content won't appear in the docs.

anpingli · 2025-07-11T09:10:07Z

+|Collectors are consuming too much node disk on the host.
 |Warning

+|`CollectorHigh403ForbiddenResponseRate`


This alert is for 6.3 only now.

ok, i revised the the target for this PR to 6.3. I'll create a separate PR for 6.2 and older versions.

openshift-ci-robot · 2025-07-11T11:37:50Z

@theashiot: This pull request references OBSDOCS-1801 which is a valid jira issue.

Details

In response to this:

Version(s): 6.3

Issue: https://issues.redhat.com/browse/OBSDOCS-1801

Link to docs preview:
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/custom-logging-alerts.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/default-logging-alerts.html

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

theashiot

Thanks, @mburke5678 for the wonderful review! i've made the suggested changes.
best,
ashwin

theashiot · 2025-07-11T11:50:06Z

+|Collectors are consuming too much node disk on the host.
 |Warning

+|`CollectorHigh403ForbiddenResponseRate`


ok, i revised the the target for this PR to 6.3. I'll create a separate PR for 6.2 and older versions.

theashiot · 2025-07-11T11:51:21Z

 = Logging collector alerts

-In logging 5.8 and later versions, the following alerts are generated by the {clo}. You can view these alerts in the {ocp-product-title} web console.
+The following alerts are generated by the {clo}. You can view these alerts in the {ocp-product-title} web console.


This file is not included so the content won't appear in the docs.

theashiot · 2025-07-14T07:02:37Z

 = Configuring the ruler

-When the LokiStack ruler component is enabled, users can define a group of link:https://grafana.com/docs/loki/latest/query/[LogQL] expressions that trigger logging alerts or recorded metrics.
+When the `LokiStack` ruler component is enabled, users can define a group of link:https://grafana.com/docs/loki/latest/query/[LogQL] expressions that trigger logging alerts or recorded metrics.


theashiot · 2025-07-14T07:06:17Z

+
+|`LokiReadPathHighLoad`
+|`The read path is experiencing high load.`
+|The read path has high volume of queries  causing longer response times.


yep, reads much better

theashiot · 2025-07-14T12:09:17Z

+
+|`LokistackSchemaUpgradesRequired`
+|`The LokiStack "{{ $labels.stack_name }}" in namespace "<namespace>" is using a storage schema
+configuration that does not contain the latest schema version. It is recommended to update the schema configuration to update the schema version to the latest` 


Good catch, @mburke5678! This is the output text. I believe this should first be fixed upstream first, cc @xperimental

anpingli · 2025-07-15T08:39:02Z

/lgtm

theashiot · 2025-07-15T09:58:08Z

Thanks, @anpingli!

openshift-ci-robot · 2025-07-15T09:58:20Z

@theashiot: This pull request references OBSDOCS-1801 which is a valid jira issue.

Details

In response to this:

Version(s): 6.3

Issue: https://issues.redhat.com/browse/OBSDOCS-1801

Link to docs preview:
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/custom-logging-alerts.html
https://94828--ocpdocs-pr.netlify.app/openshift-logging/latest/logging_alerts/default-logging-alerts.html

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci · 2025-07-15T11:52:50Z

New changes are detected. LGTM label has been removed.

theashiot · 2025-07-15T11:55:10Z

@theashiot A few comments. Otherwise LGTM.

I know it is not part of this PR, but in reviewing the preview, I noticed this:

Thanks for catching this! I added the required procedure module labels and intro.

theashiot · 2025-07-15T12:02:20Z

/merge-review-needed

theashiot · 2025-07-15T17:51:10Z

/label merge-review-needed

gabriel-rh

/LGTM - need to fix 2 minor issues

gabriel-rh · 2025-07-16T09:37:05Z

-<2> Add a custom label that can be added to namespaces where you want to enable the use of logging alerts and metrics.
+<2> Specify the selector for the alerting and recording resources.
 <3> Add a custom label that can be added to namespaces where you want to enable the use of logging alerts and metrics.
+<4> Specify the namespaces in which the alerting and recording rules are defined for the {loki-op}. If undefined, only the rules defined in the same namespace as the `LokiStack` CR is are used.


CR is are used

I would drop the "is" - but only a suggestion for later

gabriel-rh · 2025-07-16T09:40:08Z

-The Alerting UI is accessible through the *{perspective}* perspective of the {ocp-product-title} web console.
-
 // tag::ADM[]
+You can access the *Alerting* user interface (UI) is through the *{perspective}* perspective of the {ocp-product-title} web console.


"is through" - I think the "is" here needs to be removed

gabriel-rh · 2025-07-16T09:40:36Z

-* From the *Developer* perspective, go to *Observe* and go to the *Alerts* tab.
-* Select the project that you want to manage alerts for from the *Project:* list. 
+
+You can access the *Alerting* user interface (UI) is through the *{perspective}* perspective of the {ocp-product-title} web console.


and again - remove "is"

theashiot · 2025-07-16T09:50:21Z

Thanks, @gabriel-rh for the review! I've made the required changes.

best,

ashwin

openshift-ci · 2025-07-16T10:14:13Z

@theashiot: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

gabriel-rh · 2025-07-16T10:26:13Z

/cherrypick standalone-logging-docs-6.3

openshift-cherrypick-robot · 2025-07-16T10:27:05Z

@gabriel-rh: new pull request created: #96166

Details

In response to this:

/cherrypick standalone-logging-docs-6.3

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 16, 2025

openshift-ci Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 16, 2025

theashiot force-pushed the OBSDOCS-1801 branch 4 times, most recently from 62aad81 to d86fbca Compare June 23, 2025 11:43

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 23, 2025

openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 23, 2025

theashiot force-pushed the OBSDOCS-1801 branch from d86fbca to c41427a Compare June 23, 2025 11:47

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 23, 2025

xperimental reviewed Jun 30, 2025

View reviewed changes

theashiot force-pushed the OBSDOCS-1801 branch from c41427a to 6999a95 Compare July 4, 2025 11:51

xperimental reviewed Jul 8, 2025

View reviewed changes

theashiot force-pushed the OBSDOCS-1801 branch from 6999a95 to a25f912 Compare July 8, 2025 14:29

xperimental approved these changes Jul 9, 2025

View reviewed changes

theashiot force-pushed the OBSDOCS-1801 branch from a25f912 to 8125990 Compare July 10, 2025 18:34

anpingli reviewed Jul 11, 2025

View reviewed changes

theashiot force-pushed the OBSDOCS-1801 branch from 8125990 to 77d62ad Compare July 11, 2025 11:50

mburke5678 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Jul 11, 2025

theashiot force-pushed the OBSDOCS-1801 branch 3 times, most recently from d4df9d9 to e8dd65b Compare July 14, 2025 20:59

theashiot commented Jul 14, 2025

View reviewed changes

openshift-ci Bot assigned anpingli Jul 15, 2025

openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2025

theashiot force-pushed the OBSDOCS-1801 branch from e8dd65b to 3fcff6e Compare July 15, 2025 11:52

openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2025

openshift-ci Bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 15, 2025

gabriel-rh approved these changes Jul 16, 2025

View reviewed changes

gabriel-rh added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jul 16, 2025

OBSDOCS-1801: Loki - Adjust Queries for both OTEL and ViaQ

48530fe

theashiot force-pushed the OBSDOCS-1801 branch from 3fcff6e to 48530fe Compare July 16, 2025 09:49

gabriel-rh merged commit c6a53ad into openshift:standalone-logging-docs-main Jul 16, 2025
2 checks passed

openshift-cherrypick-robot mentioned this pull request Jul 16, 2025

[standalone-logging-docs-6.3] OBSDOCS-1801: Loki - Adjust Queries for both OTEL and ViaQ #96166

Merged

	\| infrastructure \| `openshift-\`, `kube-`, `default`
	\| infrastructure \| `openshift-`, `kube-`, `default`

	<3> `AlertingRule` CRs for `infrastructure` tenants are only supported in the `openshift-\`, `kube-`, or `default` namespaces.
	<3> `AlertingRule` CRs for `infrastructure` tenants are only supported in the `openshift-`, `kube-`, or `default` namespaces.

Conversation

theashiot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Jun 16, 2025 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Jun 23, 2025 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xperimental left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

theashiot commented Jul 7, 2025

Uh oh!

xperimental left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

theashiot Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

xperimental left a comment

Choose a reason for hiding this comment

Uh oh!

theashiot commented Jul 9, 2025

Uh oh!

theashiot commented Jul 9, 2025

Uh oh!

theashiot commented Jul 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci-robot commented Jul 11, 2025 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theashiot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

theashiot commented Jun 16, 2025 •

edited

Loading

openshift-ci-robot commented Jun 16, 2025 •

edited by openshift-ci Bot

Loading

ocpdocs-previewbot commented Jun 16, 2025 •

edited

Loading

openshift-ci-robot commented Jun 23, 2025 •

edited by openshift-ci Bot

Loading

theashiot Jul 8, 2025 •

edited

Loading

openshift-ci-robot commented Jul 11, 2025 •

edited by openshift-ci Bot

Loading

openshift-ci-robot commented Jul 15, 2025 •

edited by openshift-ci Bot

Loading