diff --git a/installing/installing-logging.adoc b/installing/installing-logging.adoc index 23f9c9221e00..73524a4837b3 100644 --- a/installing/installing-logging.adoc +++ b/installing/installing-logging.adoc @@ -38,6 +38,7 @@ The following sections describe installing the {loki-op} and the {clo} by using include::modules/installing-loki-operator-cli.adoc[leveloffset=+2] include::modules/installing-logging-operator-cli.adoc[leveloffset=+2] +include::modules/installing-the-logging-ui-plug-in-cli.adoc[leveloffset=+2] [id="installing-loki-and-logging-gui_{context}"] == Installation by using the web console @@ -46,6 +47,7 @@ The following sections describe installing the {loki-op} and the {clo} by using include::modules/installing-loki-operator-web-console.adoc[leveloffset=+2] include::modules/installing-logging-operator-web-console.adoc[leveloffset=+2] +include::modules/installing-the-logging-ui-plug-in-gui.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources diff --git a/modules/installing-the-logging-ui-plug-in-cli.adoc b/modules/installing-the-logging-ui-plug-in-cli.adoc new file mode 100644 index 000000000000..caffc8a1db20 --- /dev/null +++ b/modules/installing-the-logging-ui-plug-in-cli.adoc @@ -0,0 +1,64 @@ +// Module included in the following assemblies: +// +// * installing/installing-logging.adoc + +:_newdoc-version: 2.18.4 +:_template-generated: 2025-04-18 +:_mod-docs-content-type: PROCEDURE + +[id="installing-the-logging-ui-plugin-cli_{context}"] += Installing the logging UI plugin by using the CLI + +Install the logging UI plugin by using the command-line interface (CLI) so that you can visualize logs. + +.Prerequisites +* You have administrator permissions. +* You installed the {oc-first}. +* You installed and configured {loki-op}. + +.Procedure +. Install the {coo-full}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/cluster_observability_operator/installing-cluster-observability-operators[Installing the Cluster Observability Operator]. + +. Create a `UIPlugin` custom resource (CR): ++ +.Example `UIPlugin` CR +[source,yaml] +---- +apiVersion: observability.openshift.io/v1alpha1 +kind: UIPlugin +metadata: + name: logging # <1> +spec: + type: Logging # <2> + logging: + lokiStack: + name: logging-loki # <3> + logsLimit: 50 + timeout: 30s + schema: otel # <4> +---- +<1> Set `name` to `logging`. +<2> Set `type` to `Logging`. +<3> The `name` value must match the name of your LokiStack instance. If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration. +<4> `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. ++ +[NOTE] +==== +These are the known issues for the logging UI plugin - for more information, see link:https://issues.redhat.com/browse/OU-587[OU-587]. + +* The `schema` feature is only supported in {product-title} 4.15 and later. In earlier versions of {product-title}, 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} versions 5.8 to 6.2. This issue will be fixed in a future {logging} release. (https://issues.redhat.com/browse/LOG-6589[LOG-6589]) +* In {logging} {for} version 5.9, the `severity_text` Otel attribute is not set. +==== + +. Apply the `UIPlugin` CR object by running the following command: ++ +[source,terminal] +---- +$ oc apply -f .yaml +---- + +.Verification + +. Access the {product-title} web console, and refresh the page if a pop-up message instructs you to do so. +. Navigate to the *Observe → Logs* panel, where you can run LogQL queries. You can also query logs for individual pods from the *Aggregated Logs* tab of a specific pod. \ No newline at end of file diff --git a/modules/installing-the-logging-ui-plug-in-gui.adoc b/modules/installing-the-logging-ui-plug-in-gui.adoc new file mode 100644 index 000000000000..ffca20715392 --- /dev/null +++ b/modules/installing-the-logging-ui-plug-in-gui.adoc @@ -0,0 +1,61 @@ +// Module included in the following assemblies: +// +// * installing/installing-logging.adoc + +:_newdoc-version: 2.18.4 +:_template-generated: 2025-04-18 +:_mod-docs-content-type: PROCEDURE + +[id="installing-the-logging-ui-plugin_gui{context}"] += Installing the logging UI plugin by using the web console + +Install the logging UI plugin by using the web console so that you can visualize logs. + +.Prerequisites +* You have administrator permissions. +* You have access to the {product-title} web console. +* You installed and configured {loki-op}. + +.Procedure +. Install the {coo-full}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/cluster_observability_operator/installing-cluster-observability-operators[Installing the Cluster Observability Operator]. + +. Navigate to the *Installed Operators* page. Under *Provided APIs*, select *ClusterObservabilityOperator*. Find the `UIPlugin` resource and click *Create Instance*. + +. Select the YAML view, and then use the following template to create a `UIPlugin` custom resource (CR): ++ +.Example `UIPlugin` CR +[source,yaml] +---- +apiVersion: observability.openshift.io/v1alpha1 +kind: UIPlugin +metadata: + name: logging # <1> +spec: + type: Logging # <2> + logging: + lokiStack: + name: logging-loki # <3> + logsLimit: 50 + timeout: 30s + schema: otel # <4> +---- +<1> Set `name` to `logging`. +<2> Set `type` to `Logging`. +<3> The `name` value must match the name of your LokiStack instance. If you did not install LokiStack in the `openshift-logging` namespace, set the LokiStack namespace under the `lokiStack` configuration. +<4> `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. ++ +[NOTE] +==== +These are the known issues for the logging UI plugin - for more information, see link:https://issues.redhat.com/browse/OU-587[OU-587]. + +* The `schema` feature is only supported in {product-title} 4.15 and later. In earlier versions of {product-title}, 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} versions 5.8 to 6.2. This issue will be fixed in a future {logging} release. (https://issues.redhat.com/browse/LOG-6589[LOG-6589]) +* In {logging} {for} version 5.9, the `severity_text` Otel attribute is not set. +==== + +. Click *Create*. + +.Verification + +. Refresh the page when a pop-up message instructs you to do so. +. Navigate to the *Observe → Logs* panel, where you can run LogQL queries. You can also query logs for individual pods from the *Aggregated Logs* tab of a specific pod. \ No newline at end of file