Chapter 50. EntityUserOperatorSpec schema reference
Used in: EntityOperatorSpec
Full list of EntityUserOperatorSpec
schema properties
Configures the User Operator.
50.1. logging
The User Operator has a configurable logger:
-
rootLogger.level
The User Operator uses the Apache log4j2
logger implementation.
Use the logging
property in the entityOperator.userOperator
field of the Kafka
resource to configure loggers and logger levels.
You can set the log levels by specifying the logger and level directly (inline) or use a custom (external) ConfigMap. If a ConfigMap is used, you set logging.valueFrom.configMapKeyRef.name
property to the name of the ConfigMap containing the external logging configuration. Inside the ConfigMap, the logging configuration is described using log4j2.properties
. Both logging.valueFrom.configMapKeyRef.name
and logging.valueFrom.configMapKeyRef.key
properties are mandatory. A ConfigMap using the exact logging configuration specified is created with the custom resource when the Cluster Operator is running, then recreated after each reconciliation. If you do not specify a custom ConfigMap, default logging settings are used. If a specific logger value is not set, upper-level logger settings are inherited for that logger. For more information about log levels, see Apache logging services.
Here we see examples of inline
and external
logging. The inline
logging specifies the rootLogger.level
. You can also set log levels for specific classes or loggers by adding them to the loggers property.
Inline logging
apiVersion: kafka.strimzi.io/v1beta2 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... entityOperator: # ... userOperator: watchedNamespace: my-topic-namespace reconciliationIntervalSeconds: 60 logging: type: inline loggers: rootLogger.level: INFO logger.uop.name: io.strimzi.operator.user 1 logger.uop.level: DEBUG 2 logger.abstractcache.name: io.strimzi.operator.user.operator.cache.AbstractCache 3 logger.abstractcache.level: TRACE 4 logger.jetty.level: DEBUG 5 # ...
- 1
- Creates a logger for the
user
package. - 2
- Sets the logging level for the
user
package. - 3
- Creates a logger for the
AbstractCache
class. - 4
- Sets the logging level for the
AbstractCache
class. - 5
- Changes the logging level for the default
jetty
logger. Thejetty
logger is part of the logging configuration provided with Streams for Apache Kafka. By default, it is set toINFO
.
When investigating an issue with the operator, it’s usually sufficient to change the rootLogger
to DEBUG
to get more detailed logs. However, keep in mind that setting the log level to DEBUG
may result in a large amount of log output and may have performance implications.
External logging
apiVersion: kafka.strimzi.io/v1beta2 kind: Kafka metadata: name: my-cluster spec: kafka: # ... zookeeper: # ... entityOperator: # ... userOperator: watchedNamespace: my-topic-namespace reconciliationIntervalSeconds: 60 logging: type: external valueFrom: configMapKeyRef: name: customConfigMap key: user-operator-log4j2.properties # ...
Garbage collector (GC)
Garbage collector logging can also be enabled (or disabled) using the jvmOptions
property.
50.2. EntityUserOperatorSpec
schema properties
Property | Property type | Description |
---|---|---|
watchedNamespace | string | The namespace the User Operator should watch. |
image | string | The image to use for the User Operator. |
reconciliationIntervalSeconds | integer | Interval between periodic reconciliations. |
zookeeperSessionTimeoutSeconds | integer |
The |
secretPrefix | string | The prefix that will be added to the KafkaUser name to be used as the Secret name. |
livenessProbe | Pod liveness checking. | |
readinessProbe | Pod readiness checking. | |
resources | CPU and memory resources to reserve. | |
logging | Logging configuration. | |
jvmOptions | JVM Options for pods. |