Add example to show how users can customize log4j properties via Kafk…

…aCluster CR (banzaicloud#910)
adobe · Dec 13, 2022 · 08b2a9f · 08b2a9f
1 parent 62aa764
commit 08b2a9f
Showing 1 changed file with 77 additions and 0 deletions.
diff --git a/config/samples/banzaicloud_v1beta1_kafkacluster.yaml b/config/samples/banzaicloud_v1beta1_kafkacluster.yaml
@@ -77,6 +77,83 @@ spec:
       # priorityClassName can be used to set the priority of broker pods that use this config group
       # note that the corresponding PriorityClass must be created beforehand
       # priorityClassName: "high-priority"
+
+      # Add custom log4j configurations
+      # Note: all these configurations are stored in /config/log4j.properties in the corresponding kafka pod
+      # log4jConfig: |
+        # log4j.rootLogger=DEBUG, stdout, kafkaAppender
+
+        # log4j.appender.stdout=org.apache.log4j.ConsoleAppender
+        # log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
+        # log4j.appender.stdout.layout.ConversionPattern=[%d] %p %m (%c)%n
+
+        # log4j.appender.kafkaAppender=org.apache.log4j.DailyRollingFileAppender
+        # log4j.appender.kafkaAppender.DatePattern='.'yyyy-MM-dd-HH
+        # log4j.appender.kafkaAppender.File=${kafka.logs.dir}/server.log
+        # log4j.appender.kafkaAppender.layout=org.apache.log4j.PatternLayout
+        # log4j.appender.kafkaAppender.layout.ConversionPattern=[%d] %p %m (%c)%n
+
+        # log4j.appender.stateChangeAppender=org.apache.log4j.DailyRollingFileAppender
+        # log4j.appender.stateChangeAppender.DatePattern='.'yyyy-MM-dd-HH
+        # log4j.appender.stateChangeAppender.File=${kafka.logs.dir}/state-change.log
+        # log4j.appender.stateChangeAppender.layout=org.apache.log4j.PatternLayout
+        # log4j.appender.stateChangeAppender.layout.ConversionPattern=[%d] %p %m (%c)%n
+
+        # log4j.appender.requestAppender=org.apache.log4j.DailyRollingFileAppender
+        # log4j.appender.requestAppender.DatePattern='.'yyyy-MM-dd-HH
+        # log4j.appender.requestAppender.File=${kafka.logs.dir}/kafka-request.log
+        # log4j.appender.requestAppender.layout=org.apache.log4j.PatternLayout
+        # log4j.appender.requestAppender.layout.ConversionPattern=[%d] %p %m (%c)%n
+
+        # log4j.appender.cleanerAppender=org.apache.log4j.DailyRollingFileAppender
+        # log4j.appender.cleanerAppender.DatePattern='.'yyyy-MM-dd-HH
+        # log4j.appender.cleanerAppender.File=${kafka.logs.dir}/log-cleaner.log
+        # log4j.appender.cleanerAppender.layout=org.apache.log4j.PatternLayout
+        # log4j.appender.cleanerAppender.layout.ConversionPattern=[%d] %p %m (%c)%n
+
+        # log4j.appender.controllerAppender=org.apache.log4j.DailyRollingFileAppender
+        # log4j.appender.controllerAppender.DatePattern='.'yyyy-MM-dd-HH
+        # log4j.appender.controllerAppender.File=${kafka.logs.dir}/controller.log
+        # log4j.appender.controllerAppender.layout=org.apache.log4j.PatternLayout
+        # log4j.appender.controllerAppender.layout.ConversionPattern=[%d] %p %m (%c)%n
+
+        # log4j.appender.authorizerAppender=org.apache.log4j.DailyRollingFileAppender
+        # log4j.appender.authorizerAppender.DatePattern='.'yyyy-MM-dd-HH
+        # log4j.appender.authorizerAppender.File=${kafka.logs.dir}/kafka-authorizer.log
+        # log4j.appender.authorizerAppender.layout=org.apache.log4j.PatternLayout
+        # log4j.appender.authorizerAppender.layout.ConversionPattern=[%d] %p %m (%c)%n
+
+        ## Change the line below to adjust ZK client logging
+        # log4j.logger.org.apache.zookeeper=INFO
+
+        ## Change the two lines below to adjust the general broker logging level (output to server.log and stdout)
+        # log4j.logger.kafka=INFO
+        # log4j.logger.org.apache.kafka=INFO
+
+        ## Change to DEBUG or TRACE to enable request logging
+        # log4j.logger.kafka.request.logger=WARN, requestAppender
+        # log4j.additivity.kafka.request.logger=false
+
+        ## Uncomment the lines below and change log4j.logger.kafka.network.RequestChannel$ to TRACE for additional output
+        ## related to the handling of requests
+        ##log4j.logger.kafka.network.Processor=TRACE, requestAppender
+        ##log4j.logger.kafka.server.KafkaApis=TRACE, requestAppender
+        ##log4j.additivity.kafka.server.KafkaApis=false
+        # log4j.logger.kafka.network.RequestChannel$=WARN, requestAppender
+        # log4j.additivity.kafka.network.RequestChannel$=false
+
+        # log4j.logger.kafka.controller=TRACE, controllerAppender
+        # log4j.additivity.kafka.controller=false
+
+        # log4j.logger.kafka.log.LogCleaner=INFO, cleanerAppender
+        # log4j.additivity.kafka.log.LogCleaner=false
+
+        # log4j.logger.state.change.logger=INFO, stateChangeAppender
+        # log4j.additivity.state.change.logger=false
+
+        ## Access denials are logged at INFO level, change to DEBUG to also log allowed accesses
+        # log4j.logger.kafka.authorizer.logger=INFO, authorizerAppender
+        # log4j.additivity.kafka.authorizer.logger=false
   # All Broker requires an image, unique id, and storageConfigs settings
   brokers:
     # Unique broker id which is used as kafka config broker.id