1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Files
openshift-docs/modules/configuring-log-visualizer.adoc
Satyajeet Munje cc94fd4ee0 OBSDOCS-693
2024-04-24 18:11:38 +00:00

60 lines
1.7 KiB
Plaintext

// Module included in the following assemblies:
//
// * observability/logging/log_visualization/log-visualization.adoc
// * observability/logging/cluster-logging-deploying.adoc
:_mod-docs-content-type: PROCEDURE
[id="configuring-log-visualizer_{context}"]
= Configuring the log visualizer
You can configure which log visualizer type your {logging} uses by modifying the `ClusterLogging` custom resource (CR).
.Prerequisites
* You have administrator permissions.
* You have installed the {oc-first}.
* You have installed the {clo}.
* You have created a `ClusterLogging` CR.
[IMPORTANT]
====
If you want to use the {product-title} web console for visualization, you must enable the {log-plug}. See the documentation about "Log visualization with the web console".
====
.Procedure
. Modify the `ClusterLogging` CR `visualization` spec:
+
.`ClusterLogging` CR example
[source,yaml]
----
apiVersion: logging.openshift.io/v1
kind: ClusterLogging
metadata:
# ...
spec:
# ...
visualization:
type: <visualizer_type> <1>
kibana: <2>
resources: {}
nodeSelector: {}
proxy: {}
replicas: {}
tolerations: {}
ocpConsole: <3>
logsLimit: {}
timeout: {}
# ...
----
<1> The type of visualizer you want to use for your {logging}. This can be either `kibana` or `ocp-console`. The Kibana console is only compatible with deployments that use Elasticsearch log storage, while the {product-title} console is only compatible with LokiStack deployments.
<2> Optional configurations for the Kibana console.
<3> Optional configurations for the {product-title} web console.
. Apply the `ClusterLogging` CR by running the following command:
+
[source,terminal]
----
$ oc apply -f <filename>.yaml
----