Skip to content

Commit 1d1f9e4

Browse files
committed
readme: describe mapping between LogLevel and log level
1 parent dafd2d1 commit 1d1f9e4

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,65 @@ spec:
6363
managementState: Managed
6464
```
6565
66+
The log level of individual kube-apiserver instances can be increased by setting `.spec.logLevel` field:
67+
```
68+
$ oc explain KubeAPIServer.spec.logLevel
69+
GROUP: operator.openshift.io
70+
KIND: KubeAPIServer
71+
VERSION: v1
72+
73+
FIELD: logLevel <string>
74+
75+
DESCRIPTION:
76+
logLevel is an intent based logging for an overall component. It does not
77+
give fine grained control, but it is a simple way to manage coarse grained
78+
logging choices that operators have to interpret for their operands.
79+
Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to
80+
"Normal".
81+
```
82+
For example:
83+
```yaml
84+
apiVersion: operator.openshift.io/v1
85+
kind: KubeAPIServer
86+
metadata:
87+
name: cluster
88+
spec:
89+
logLevel: Debug
90+
...
91+
```
92+
93+
Currently the log levels correspond to:
94+
95+
| logLevel | log level |
96+
| -------- | --------- |
97+
| Normal | 2 |
98+
| Debug | 4 |
99+
| Trace | 6 |
100+
| TraceAll | 10 |
101+
102+
103+
The log level of cluster-kube-apiserver-operator can be increased by setting `.spec.operatorLogLevel` field:
104+
For example:
105+
```yaml
106+
apiVersion: operator.openshift.io/v1
107+
kind: KubeAPIServer
108+
metadata:
109+
name: cluster
110+
spec:
111+
operatorLogLevel: Debug
112+
...
113+
```
114+
115+
Currently the operator log levels correspond to:
116+
117+
| operatorLogLevel | log level |
118+
| ---------------- | --------- |
119+
| Normal | 2 |
120+
| Debug | 4 |
121+
| Trace | 6 |
122+
| TraceAll | 8 |
123+
124+
66125
The current operator status is reported using the `ClusterOperator` resource. To get the current status you can run follow command:
67126

68127
```

0 commit comments

Comments
 (0)