Skip to content

Commit 5ff59cb

Browse files
theashiotopenshift-cherrypick-robot
theashiot
authored and
openshift-cherrypick-robot
committed
OBSDOCS-1982: Transfer UIPlugin content to standalone
1 parent 8a0781e commit 5ff59cb

File tree

3 files changed

+127
-0
lines changed

3 files changed

+127
-0
lines changed

‎installing/installing-logging.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ The following sections describe installing the {loki-op} and the {clo} by using
3838

3939
include::modules/installing-loki-operator-cli.adoc[leveloffset=+2]
4040
include::modules/installing-logging-operator-cli.adoc[leveloffset=+2]
41+
include::modules/installing-the-logging-ui-plug-in-cli.adoc[leveloffset=+2]
4142

4243
[id="installing-loki-and-logging-gui_{context}"]
4344
== Installation by using the web console
@@ -46,6 +47,7 @@ The following sections describe installing the {loki-op} and the {clo} by using
4647

4748
include::modules/installing-loki-operator-web-console.adoc[leveloffset=+2]
4849
include::modules/installing-logging-operator-web-console.adoc[leveloffset=+2]
50+
include::modules/installing-the-logging-ui-plug-in-gui.adoc[leveloffset=+2]
4951

5052
[role="_additional-resources"]
5153
.Additional resources

‎modules/installing-the-logging-ui-plug-in-cli.adoc‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing-logging.adoc
4+
5+
:_newdoc-version: 2.18.4
6+
:_template-generated: 2025-04-18
7+
:_mod-docs-content-type: PROCEDURE
8+
9+
[id="installing-the-logging-ui-plugin-cli_{context}"]
10+
= Installing the logging UI plugin by using the CLI
11+
12+
Install the logging UI plugin by using the command-line interface (CLI) so that you can visualize logs.
13+
14+
.Prerequisites
15+
* You have administrator permissions.
16+
* You installed the {oc-first}.
17+
* You installed and configured {loki-op}.
18+
19+
.Procedure
20+
. 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].
21+
22+
. Create a `UIPlugin` custom resource (CR):
23+
+
24+
.Example `UIPlugin` CR
25+
[source,yaml]
26+
----
27+
apiVersion: observability.openshift.io/v1alpha1
28+
kind: UIPlugin
29+
metadata:
30+
name: logging # <1>
31+
spec:
32+
type: Logging # <2>
33+
logging:
34+
lokiStack:
35+
name: logging-loki # <3>
36+
logsLimit: 50
37+
timeout: 30s
38+
schema: otel # <4>
39+
----
40+
<1> Set `name` to `logging`.
41+
<2> Set `type` to `Logging`.
42+
<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.
43+
<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.
44+
+
45+
[NOTE]
46+
====
47+
These are the known issues for the logging UI plugin - for more information, see link:https://issues.redhat.com/browse/OU-587[OU-587].
48+
49+
* 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.
50+
* 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])
51+
* In {logging} {for} version 5.9, the `severity_text` Otel attribute is not set.
52+
====
53+
54+
. Apply the `UIPlugin` CR object by running the following command:
55+
+
56+
[source,terminal]
57+
----
58+
$ oc apply -f <filename>.yaml
59+
----
60+
61+
.Verification
62+
63+
. Access the {product-title} web console, and refresh the page if a pop-up message instructs you to do so.
64+
. 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.

‎modules/installing-the-logging-ui-plug-in-gui.adoc‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing-logging.adoc
4+
5+
:_newdoc-version: 2.18.4
6+
:_template-generated: 2025-04-18
7+
:_mod-docs-content-type: PROCEDURE
8+
9+
[id="installing-the-logging-ui-plugin_gui{context}"]
10+
= Installing the logging UI plugin by using the web console
11+
12+
Install the logging UI plugin by using the web console so that you can visualize logs.
13+
14+
.Prerequisites
15+
* You have administrator permissions.
16+
* You have access to the {product-title} web console.
17+
* You installed and configured {loki-op}.
18+
19+
.Procedure
20+
. 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].
21+
22+
. Navigate to the *Installed Operators* page. Under *Provided APIs*, select *ClusterObservabilityOperator*. Find the `UIPlugin` resource and click *Create Instance*.
23+
24+
. Select the YAML view, and then use the following template to create a `UIPlugin` custom resource (CR):
25+
+
26+
.Example `UIPlugin` CR
27+
[source,yaml]
28+
----
29+
apiVersion: observability.openshift.io/v1alpha1
30+
kind: UIPlugin
31+
metadata:
32+
name: logging # <1>
33+
spec:
34+
type: Logging # <2>
35+
logging:
36+
lokiStack:
37+
name: logging-loki # <3>
38+
logsLimit: 50
39+
timeout: 30s
40+
schema: otel # <4>
41+
----
42+
<1> Set `name` to `logging`.
43+
<2> Set `type` to `Logging`.
44+
<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.
45+
<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.
46+
+
47+
[NOTE]
48+
====
49+
These are the known issues for the logging UI plugin - for more information, see link:https://issues.redhat.com/browse/OU-587[OU-587].
50+
51+
* 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.
52+
* 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])
53+
* In {logging} {for} version 5.9, the `severity_text` Otel attribute is not set.
54+
====
55+
56+
. Click *Create*.
57+
58+
.Verification
59+
60+
. Refresh the page when a pop-up message instructs you to do so.
61+
. 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.

0 commit comments

Comments
 (0)