This is a cache of https://docs.okd.io/latest/observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.html. It is a snapshot of the page at 2025-09-09T19:06:50.042+0000.
Logging UI plugin - Cluster Observability Operator | Observability | OKD 4
  1. Documentation
×

Logging UI plugin

Starting with OKD 4.19, the perspectives in the web console have unified. The Developer perspective is no longer enabled by default.

All users can interact with all OKD web console features. However, if you are not the cluster owner, you might need to request permission to access certain features from the cluster owner.

You can still enable the Developer perspective. On the Getting Started pane in the web console, you can take a tour of the console, find information on setting up your cluster, view a quick start for enabling the Developer perspective, and follow links to explore new features and capabilities.

The logging UI plugin surfaces logging data in the OKD web console on the Observe → Logs page. You can specify filters, queries, time ranges and refresh rates, with the results displayed as a list of collapsed logs, which can then be expanded to show more detailed information for each log.

If you also deploy the Troubleshooting UI plugin on OKD version 4.16+, it connects to the Korrel8r service and adds direct links to the web console, from the Observe → Logs page, to the Observe → Metrics page with a correlated PromQL query. The plugin also adds a See Related Logs link from the web console alerting detail page, at Observe → Alerting, to the Observe → Logs page with a correlated filter set selected.

The features of the plugin are categorized as:

dev-console

Adds the logging view to the web console.

alerts

Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view.

dev-alerts

Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view for the web console.

For Cluster Observability Operator (COO) versions, the support for these features in OKD versions is shown in the following table:

COO version OCP versions Features

0.3.0+

4.12

dev-console

0.3.0+

4.13

dev-console, alerts

0.3.0+

4.14+

dev-console, alerts, dev-alerts

Installing the Cluster Observability Operator logging UI plugin

Prerequisites

  • You have access to the cluster as a user with the cluster-admin role.

  • You have logged in to the OKD web console.

  • You have installed the Cluster Observability Operator.

  • You have a LokiStack instance in your cluster.

Procedure

  1. In the OKD web console, click Operators → Installed Operators and select Cluster Observability Operator.

  2. Choose the UI Plugin tab (at the far right of the tab list) and click Create UIPlugin.

  3. Select YAML view, enter the following content, and then click Create:

    apiVersion: observability.openshift.io/v1alpha1
kind: UIPlugin
metadata:
  name: logging
spec:
  type: Logging
  logging:
    lokiStack:
      name: logging-loki
    logsLimit: 50
    timeout: 30s
    schema: otel (1)
    1 schema is one of otel, viaq, or select. The default is viaq if no value is specified. When you choose select, you can select the mode in the UI when you run a query.

    These are the known issues for the logging UI plugin - for more information, see OU-587.

    • The schema feature is only supported in OKD 4.15 and later. In earlier versions of OKD, the logging UI plugin will only use the viaq attribute, ignoring any other values that might be set.

    • Non-administrator users cannot query logs using the otel attribute with logging for Red Hat OpenShift versions 5.8 to 6.2. This issue will be fixed in a future logging release. (LOG-6589)

    • In logging for Red Hat OpenShift version 5.9, the severity_text Otel attribute is not set.