Skip to content

Commit 7573d9d

Browse files
committed
OSDOCS-12713 Module for changing CVO log levels
1 parent 666dad7 commit 7573d9d

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

modules/changing-cvo-log-level.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/troubleshooting_updates/gathering-data-cluster-update.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="changing-log-data_{context}"]
7+
= Changing CVO log level (Technology Preview)
8+
9+
:FeatureName: Changing the CVO log level
10+
include::snippets/technology-preview.adoc[]
11+
12+
The Cluster Version Operator (CVO) log level verbosity can be changed by the cluster administrator. There are four log levels.
13+
14+
* `Normal` - The default log level. Contains working log information. Used when everything is fine. Provides helpful notices for auditing or common operations.
15+
* `Debug` - Used when something goes wrong. Expect a higher quantity of notices.
16+
* `Trace` - Used to diagnose errors.
17+
* `TraceAll` - Used to get the complete body content of the logs.
18+
19+
[NOTE]
20+
====
21+
If `TraceAll` is turned on in a production cluster it may cause widespread performance issues and large log files.
22+
====
23+
24+
.Prerequisites
25+
* You have access to the cluster as a user with the `cluster-admin` role.
26+
* You have installed the {oc-first}.
27+
* You have the `TechPreviewNoUpgrade` feature set enabled.
28+
29+
.Procedure
30+
31+
. Enter the following command into the CLI.
32+
33+
[source,terminal]
34+
----
35+
$ oc patch clusterversionoperator/cluster --type=merge --patch '{"spec":{"operatorLogLevel":"<log_level>"}}'
36+
----
37+
38+
.Example output
39+
[source,terminal]
40+
----
41+
clusterversionoperator.operator.openshift.io/cluster patched
42+
----

updating/troubleshooting_updates/gathering-data-cluster-update.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ endif::openshift-origin[]
1515

1616
include::modules/gathering-log-data.adoc[leveloffset=+1]
1717

18+
include::modules/changing-cvo-log-level.adoc[leveloffset=+1]
19+
1820
include::modules/update-upgrading-oc-adm-upgrade-status.adoc[leveloffset=+1]
1921

2022
include::modules/gathering-clusterversion-history.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)