fix: add log4j configmap for radar-fitbit-connector to be used by strimzi

Author: ewelinagr

charts/radar-fitbit-connector-strimzi/README.md

@@ -89,3 +89,7 @@ A Helm chart for RADAR-base fitbit Kafka connector using the Strimzi Operator. T
 | fitbit_user_poll_interval | int | `5000` | Polling interval per Fitbit user per request route in seconds. Only use to speed up processing times during e2e testing. |
 | application_loop_interval_ms | int | `300000` | How often to perform the main application loop (only controls how often to poll for new user registrations). Only use to speed up processing times during e2e testing. |
 | user_cache_refresh_interval_ms | int | `3600000` | How often to invalidate the cache and poll for new user registrations. Only use to speed up processing times during e2e testing. |
+| log4j | object | `{"rootLogLevel":"INFO"}` | Log4j configuration |
+| log4j.rootLogLevel | string | `"INFO"` | Root log level for the Kafka Connect instance |
+| sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
+| sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |

charts/radar-fitbit-connector-strimzi/templates/configmap-log4j.yaml

@@ -0,0 +1,28 @@
+# This approach allows to specify dynamic logging configuration for Kafka Connect through an external logging section of KafkaConnect resource specification.
+# See: https://strimzi.io/docs/operators/0.45.1/configuring#property-kafka-connect-logging-reference
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ template "common.names.fullname" . }}-log4j
+  namespace: {{ include "common.names.namespace" . | quote }}
+  labels: {{- include "common.labels.standard" ( dict "customLabels" .Values.commonLabels "context" $ ) | nindent 4 }}
+  {{- if .Values.commonAnnotations }}
+  annotations: {{- include "common.tplvalues.render" ( dict "value" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+  {{- end }}
+data:
+  log4j.properties: |-
+    # Root logger configuration
+    # The sentryAppender is added to the rootLogger if SENTRY_DSN is set
+    log4j.rootLogger=${env:CONNECT_LOG4J_ROOT_LOGLEVEL:-INFO}, stdout${env:SENTRY_DSN:+, sentryAppender}
+
+    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
+
+    # Appender for Sentry monitoring, only active if SENTRY_DSN is set
+    log4j.appender.sentryAppender=io.sentry.log4j.SentryAppender
+    log4j.appender.sentryAppender.threshold=${env:SENTRY_LOG_LEVEL:-ERROR}
+
+    # Default log levels
+    log4j.logger.org.reflections=ERROR
+    log4j.logger.org.I0Itec.zkclient=ERROR

charts/radar-fitbit-connector-strimzi/templates/kafka-connect.yaml

@@ -47,6 +47,7 @@ spec:
     pod:
       metadata:
         annotations:
+          checksum/configmap-log4j: {{ include (print $.Template.BasePath "/configmap-log4j.yaml") . | sha256sum }}
           backup.velero.io/backup-volumes: logs
         labels:
           app.kubernetes.io/name: {{ include "radar-fitbit-connector-strimzi.name" . }}
@@ -85,18 +86,34 @@ spec:
       tolerations:
         {{- toYaml . | nindent 8 }}
       {{- end }}
+      volumes:
+        - name: config-log4j
+          configMap:
+            name: {{ include "radar-fitbit-connector-strimzi.fullname" . }}-log4j
       containers:
         securityContext:
           {{- toYaml .Values.securityContext | nindent 12 }}
     connectContainer:
       env:
         - name: CONNECT_REST_ADVERTISED_HOST_NAME  # Possibly replaced by ADVERTISED_HOSTNAME in kafka_connect_run.sh
           value: {{ include "radar-fitbit-connector-strimzi.fullname" . }}
-        - name: CONNECT_LOG4J_LOGGERS # Property used in log4j.properties.template file
-          value: "org.reflections=ERROR"
+        - name: CONNECT_LOG4J_ROOT_LOGLEVEL
+          value: {{ .Values.log4j.rootLogLevel | quote }}
+        - name: KAFKA_LOG4J_OPTS
+          value: "-Dlog4j.configuration=file:/opt/kafka/config/log4j.properties"
+        {{- if .Values.sentry.dsn }}
+        - name: SENTRY_DSN
+          value: {{ .Values.sentry.dsn | quote }}
+        - name: SENTRY_LOG_LEVEL
+          value: {{ .Values.sentry.level | quote }}
+        {{- end }}
         {{- with .Values.extraEnvVars }}
           {{- toYaml . | nindent 8 }}
         {{- end }}
+      volumeMounts:
+        - name: config-log4j
+          mountPath: /opt/kafka/config/log4j.properties
+          subPath: log4j.properties
   {{- if .Values.customLivenessProbe }}
   livenessProbe: {{- .Values.customLivenessProbe | toYaml | nindent 12 }}
   {{- else if .Values.livenessProbe.enabled }}

charts/radar-fitbit-connector-strimzi/values.yaml

@@ -214,3 +214,15 @@ application_loop_interval_ms: 300000
 # -- How often to invalidate the cache and poll for new user registrations.
 # Only use to speed up processing times during e2e testing.
 user_cache_refresh_interval_ms: 3600000
+
+# -- Log4j configuration
+log4j:
+  # -- Root log level for the Kafka Connect instance
+  rootLogLevel: INFO
+
+# Sentry monitoring configuration
+sentry:
+  # -- DSN (Data Source Name) of the sentry server
+  dsn:
+  # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
+  level: ERROR