feat: support setting logging levels in all components (#2324)

Co-authored-by: distro-ci[bot] <122795778+distro-ci[bot]@users.noreply.github.com>
camunda · Oct 31, 2024 · 4c12bb8 · 4c12bb8
1 parent 9787fdb
commit 4c12bb8
Show file tree

Hide file tree

Showing 11 changed files with 85 additions and 10 deletions.
diff --git a/charts/camunda-platform-alpha/README.md b/charts/camunda-platform-alpha/README.md
diff --git a/charts/camunda-platform-alpha/templates/connectors/configmap.yaml b/charts/camunda-platform-alpha/templates/connectors/configmap.yaml
@@ -48,7 +48,10 @@ data:
         security:
           plaintext: true
   {{- end }}
-
+    logging:
+{{- with .Values.connectors.logging }}
+{{ . | toYaml | indent 6 }}
+{{- end }}
   {{- range $key, $val := .Values.connectors.extraConfiguration }}
   {{ $key }}: |
     {{ $val | indent 4 | trim }}

diff --git a/charts/camunda-platform-alpha/templates/identity/configmap.yaml b/charts/camunda-platform-alpha/templates/identity/configmap.yaml
@@ -339,7 +339,10 @@ data:
         issuer: {{ include "camundaPlatform.authIssuerUrl" . | quote }}
         issuerBackendUrl: {{ include "camundaPlatform.authIssuerBackendUrl" . | quote }}
         {{- end }}
-
+    logging:
+{{- with .Values.identity.logging }}
+{{ . | toYaml | indent 6 }}
+{{- end }}
   {{- end }}
   {{- range $key, $val := .Values.identity.extraConfiguration }}
   {{ $key }}: |

diff --git a/charts/camunda-platform-alpha/templates/optimize/configmap.yaml b/charts/camunda-platform-alpha/templates/optimize/configmap.yaml
@@ -55,7 +55,6 @@ data:
     {{- end }}
   {{- end }}
 
-
   {{- if .Values.global.identity.auth.enabled }}
   application-ccsm.yaml: |
     camunda:

diff --git a/charts/camunda-platform-alpha/templates/optimize/deployment.yaml b/charts/camunda-platform-alpha/templates/optimize/deployment.yaml
@@ -208,6 +208,12 @@ spec:
             - name: CAMUNDA_OPTIMIZE_OPENSEARCH_AWS_ENABLED
               value: "true"
             {{- end }}
+            - name: OPTIMIZE_LOG_LEVEL
+              value: {{ .Values.optimize.logLevel | quote }}
+            - name: UPGRADE_LOG_LEVEL
+              value: {{ .Values.optimize.upgradeLogLevel | quote }}
+            - name: ES_LOG_LEVEL
+              value: {{ .Values.optimize.esLogLevel | quote }}
           {{- with .Values.optimize.env }}
             {{- tpl (toYaml .) $ | nindent 12 }}
           {{- end }}

diff --git a/charts/camunda-platform-alpha/templates/tasklist/configmap.yaml b/charts/camunda-platform-alpha/templates/tasklist/configmap.yaml
@@ -143,6 +143,10 @@ data:
     management.endpoints.web.exposure.include: health,info,conditions,configprops,prometheus,loggers,usage-metrics,backups
     # Enable or disable metrics
     #management.metrics.export.prometheus.enabled: false
+    logging:
+{{- with .Values.tasklist.logging }}
+{{ . | toYaml | indent 6 }}
+{{- end }}
   {{- end }}
   {{- range $key, $val := .Values.tasklist.extraConfiguration }}
   {{ $key }}: |

diff --git a/charts/camunda-platform-alpha/templates/web-modeler/configmap-restapi.yaml b/charts/camunda-platform-alpha/templates/web-modeler/configmap-restapi.yaml
@@ -87,7 +87,10 @@ data:
           resourceserver:
             jwt:
               issuer-uri: {{ include "camundaPlatform.authIssuerUrl" . | quote }}
-
+    logging:
+{{- with .Values.webModeler.restapi.logging }}
+{{ . | toYaml | indent 6 }}
+{{- end }}
   {{- end }}
   {{- range $key, $val := .Values.webModeler.restapi.extraConfiguration }}
   {{ $key }}: |

diff --git a/charts/camunda-platform-alpha/test/unit/identity/golden/configmap.golden.yaml b/charts/camunda-platform-alpha/test/unit/identity/golden/configmap.golden.yaml
@@ -296,4 +296,8 @@ data:
 
     camunda:
       identity:
-        audience: "camunda-identity-resource-server"
+        audience: "camunda-identity-resource-server"
+    logging:
+      level:
+        ROOT: WARN
+        io.camunda.identity: INFO
diff --git a/charts/camunda-platform-alpha/test/unit/optimize/golden/deployment.golden.yaml b/charts/camunda-platform-alpha/test/unit/optimize/golden/deployment.golden.yaml
@@ -109,6 +109,12 @@ spec:
                 secretKeyRef:
                   name: camunda-platform-test-optimize-identity-secret
                   key: optimize-secret
+            - name: OPTIMIZE_LOG_LEVEL
+              value: "info"
+            - name: UPGRADE_LOG_LEVEL
+              value: "info"
+            - name: ES_LOG_LEVEL
+              value: "warn"
           envFrom:
             - configMapRef:
                 name: camunda-platform-test-identity-env-vars

diff --git a/charts/camunda-platform-alpha/test/unit/tasklist/golden/configmap.golden.yaml b/charts/camunda-platform-alpha/test/unit/tasklist/golden/configmap.golden.yaml
@@ -80,4 +80,8 @@ data:
     #Spring Boot Actuator endpoints to be exposed
     management.endpoints.web.exposure.include: health,info,conditions,configprops,prometheus,loggers,usage-metrics,backups
     # Enable or disable metrics
-    #management.metrics.export.prometheus.enabled: false
+    #management.metrics.export.prometheus.enabled: false
+    logging:
+      level:
+        ROOT: INFO
+        io.camunda.tasklist: INFO
diff --git a/charts/camunda-platform-alpha/values.yaml b/charts/camunda-platform-alpha/values.yaml
@@ -1532,6 +1532,14 @@ tasklist:
   ## @param tasklist.podLabels can be used to define extra tasklist pod labels
   podLabels: {}
 
+  ## @extra tasklist.logging configuration for the tasklist logging. This template will be directly included in the tasklist configuration YAML file
+  ## @param tasklist.logging.level.ROOT
+  ## @param tasklist.logging.level.io.camunda.tasklist https://docs.camunda.io/docs/next/self-managed/tasklist-deployment/tasklist-configuration/#logging
+  logging:
+    level:
+      ROOT: INFO
+      io.camunda.tasklist: INFO
+
   ## @extra tasklist.configMap configuration which will be applied to the mounted config map.
   configMap:
     ## @param tasklist.configMap.defaultMode can be used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
@@ -1797,6 +1805,13 @@ optimize:
   ## @param optimize.podLabels can be used to define extra Optimize pod labels
   podLabels: {}
 
+  ## @param optimize.logLevel configuration for the optimize runtime environment. https://docs.camunda.io/optimize/next/self-managed/optimize-deployment/configuration/logging/
+  logLevel: info
+  ## @param optimize.upgradeLogLevel sets the logging level for the Optimize update log. https://docs.camunda.io/optimize/next/self-managed/optimize-deployment/configuration/logging/
+  upgradeLogLevel: info
+  ## @param optimize.esLogLevel sets the logging level for Elasticsearch. https://docs.camunda.io/optimize/next/self-managed/optimize-deployment/configuration/logging/
+  esLogLevel: warn
+
   ## @param optimize.partitionCount defines how many Zeebe partitions are set up in the cluster and which should be imported by Optimize
   partitionCount: "3"
   ## @param optimize.env can be used to set extra environment variables in each Optimize container
@@ -2034,7 +2049,7 @@ executionIdentity:
   ## @param executionIdentity.podLabels can be used to define extra executionIdentity pod labels
   podLabels: {}
 
-  ## @param executionIdentity.logging configuration for the executionIdentity logging. This template will be directly included in the Operate configuration YAML file
+  ## @param executionIdentity.logging configuration for the executionIdentity logging. This template will be directly included in the executionIdentity configuration YAML file
   logging: {}
 
   ## executionIdentity.service configuration to configure the executionIdentity service.
@@ -2293,6 +2308,14 @@ identity:
   ## @param identity.podLabels can be used to define extra Identity pod labels
   podLabels: {}
 
+  ## @extra identity.logging configuration for the identity logging. This template will be directly included in the identity configuration YAML file
+  ## @param identity.logging.level.ROOT
+  ## @param identity.logging.level.io.camunda.identity https://docs.camunda.io/docs/next/self-managed/identity/user-guide/configuration/configure-logging/#general-configuration-options
+  logging:
+    level:
+      ROOT: WARN
+      io.camunda.identity: INFO
+
   ## @extra identity.service configuration to configure the identity service.
   service:
     ## @param identity.service.annotations can be used to define annotations, which will be applied to the identity service
@@ -2827,6 +2850,14 @@ webModeler:
     ## @param webModeler.restapi.podLabels can be used to define extra restapi pod labels
     podLabels: {}
 
+    ## @extra webModeler.restapi.logging configuration for the restapi logging. This template will be directly included in the webModeler.restapi configuration YAML file
+    ## @param webModeler.restapi.logging.level.io.camunda.modeler https://docs.camunda.io/docs/next/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection/#how-can-i-debug-log-grpc--zeebe-communication
+    ## @param webModeler.restapi.logging.level.io.grpc
+    logging:
+      level:
+        io.camunda.modeler: DEBUG
+        io.grpc: TRACE
+
     ## @param webModeler.restapi.env can be used to set extra environment variables in each restapi container
     env: []
     ## @param webModeler.restapi.envFrom list of environment variables to import from configMapRef and secretRef
@@ -3470,7 +3501,7 @@ connectors:
   ## @param connectors.podLabels can be used to define extra Connectors pod labels
   podLabels: {}
 
-  ## @extra connectors.logging configuration for the Connectors logging. This template will be directly included in the Operate configuration YAML file
+  ## @extra connectors.logging configuration for the Connectors logging. This template will be directly included in the connector configuration YAML file
   ## @param connectors.logging.level.io.camunda.connector
   logging:
     level: