Merge pull request #365 from maykinmedia/feature/remove-clean-log-script

🔥 Replace clean-logs script with django-timeline-entries management command

Author: Silvia

charts/openforms/CHANGELOG.md

@@ -1,8 +1,15 @@
 # Changelog
 
+## 1.12.0 (2026-02-09)
+
+- Remove the config map with the clean-logs script. Since version `2.7.0` of the Open Forms app, it is not needed to prune the emails, while from `3.3.0`, Open Forms uses version `5.0.0` of `django-timeline-logger`, which includes a management command to prune the logs. The cronjob now uses this command instead of the script.
+
+  **Note**: the command in `django-timeline-logger` deletes the requested logs in one go, so if there are too many logs to delete, the job might be OOM killed.
+
+
 ## 1.11.6 (2025-12-11)
-- upgraded open-forms from 3.3.0 to 3.3.9
-  - includes patch for CVE-2025-64515
+
+- Upgraded open-forms app version from 3.3.0 to 3.3.9 (which includes a patch for CVE-2025-64515)
 
 ## 1.11.5 (2025-11-12)
 

charts/openforms/Chart.yaml

@@ -4,7 +4,7 @@ description: Snel en eenvoudig slimme formulieren bouwen en publiceren
 
 type: application
 
-version: 1.11.6
+version: 1.12.0
 appVersion: 3.3.9
 
 icon: https://open-forms.readthedocs.io/en/stable/_static/logo.svg

charts/openforms/README.md

@@ -2,7 +2,7 @@
 
 Snel en eenvoudig slimme formulieren bouwen en publiceren
 
-![Version: 1.11.6](https://img.shields.io/badge/Version-1.11.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.3.9](https://img.shields.io/badge/AppVersion-3.3.9-informational?style=flat-square)
+![Version: 1.12.0](https://img.shields.io/badge/Version-1.12.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.3.9](https://img.shields.io/badge/AppVersion-3.3.9-informational?style=flat-square)
 
 ## Introduction
 
@@ -74,6 +74,13 @@ settings:
 
 The value of the `DSN` is considered sensitive, so it should be handled as a secret.
 
+### Cleaning up logs
+
+It is possible to schedule a `CronJob` resource to clean up Timeline log entries. In order to enable it, set the value `settings.cleanLogs.enabled: true`.
+You can configure the number of days for which the logs should be kept by specifying  `settings.cleanLogs.daysRetained`. A value of `90` will keep all the logs newer than `90` days.
+
+Note that if you have accumulated a large number of logs, it is possible that the job might be OOM killed. Keep an eye on it to make sure that logs are properly deleted.
+
 ### Open Telemetry
 
 Open Forms supports the Open Telemetry Protocol.
@@ -269,9 +276,9 @@ The static file serving feature uses the existing media PVC with subPaths to org
 | settings.celery.resultBackend | string | `""` |  |
 | settings.cleanLogs.cronjob.historyLimit | int | `1` |  |
 | settings.cleanLogs.cronjob.resources | object | `{}` |  |
-| settings.cleanLogs.cronjob.schedule | string | `"0 0 * * *"` | Schedule to run the clean logs cronjob |
+| settings.cleanLogs.cronjob.schedule | string | `"0 0 * * *"` | Schedule to run the clean logs cronjob. The default will run the job every day at 00:00 |
 | settings.cleanLogs.daysRetained | int | `90` | Number of days to retain logs |
-| settings.cleanLogs.enabled | bool | `false` | Clean Logs, Messages, Timelog Entries |
+| settings.cleanLogs.enabled | bool | `false` | Clean Timeline Log entries |
 | settings.cookieSamesite | string | `""` | Choises Strict or Lax |
 | settings.cors.allowAllOrigins | bool | `false` |  |
 | settings.cors.allowedOrigins | list | `[]` |  |

charts/openforms/README.md.gotmpl

@@ -69,6 +69,13 @@ settings:
 
 The value of the `DSN` is considered sensitive, so it should be handled as a secret.
 
+### Cleaning up logs
+
+It is possible to schedule a `CronJob` resource to clean up Timeline log entries. In order to enable it, set the value `settings.cleanLogs.enabled: true`.
+You can configure the number of days for which the logs should be kept by specifying  `settings.cleanLogs.daysRetained`. A value of `90` will keep all the logs newer than `90` days.
+
+Note that if you have accumulated a large number of logs, it is possible that the job might be OOM killed. Keep an eye on it to make sure that logs are properly deleted.
+
 ### Open Telemetry
 
 Open Forms supports the Open Telemetry Protocol.

charts/openforms/templates/clean-script.yaml

@@ -44,6 +44,8 @@ spec:
                 - configMapRef:
                     name: {{ include "openforms.fullname" . }}
               env:
+                - name: OTEL_SDK_DISABLED
+                  value: "true"
                 {{- if .Values.extraEnvVars }}
                 {{- include "openforms.tplvalues.render" (dict "value" .Values.extraEnvVars "context" $) | nindent 16 }}
                 {{- end }}
@@ -52,18 +54,14 @@ spec:
               command:
                 - "/bin/bash"
                 - "-c"
-
-                -  /app/src/manage.py shell < /app/scripts/clean_logs.py
+                -  /app/src/manage.py prune_timeline_logs --no-input --keep-days {{ .Values.settings.cleanLogs.daysRetained }}
               volumeMounts:
                 - name: media
                   mountPath: /app/private_media
                   subPath: {{ .Values.persistence.privateMediaMountSubpath | default "openforms/private_media" }}
                 - name: media
                   mountPath: /app/media
-                  subPath: {{ .Values.persistence.mediaMountSubpath  | default "openforms/media" }}
-                - name: clean-logs
-                  mountPath: /app/scripts/
-                  readOnly: true                  
+                  subPath: {{ .Values.persistence.mediaMountSubpath  | default "openforms/media" }}         
                 {{- if .Values.extraVolumeMounts }}
                 {{- include "openforms.tplvalues.render" ( dict "value" .Values.extraVolumeMounts "context" $ ) | nindent 16 }}
                 {{- end }}
@@ -74,11 +72,7 @@ spec:
                 claimName: {{ if .Values.persistence.existingClaim }}{{ .Values.persistence.existingClaim }}{{- else }}{{ include "openforms.fullname" . }}{{- end }}
               {{- else }}
               emptyDir: { }
-              {{- end }}
-            - name: clean-logs
-              configMap:
-                name: {{ include "openforms.fullname" . }}-clean-logs
-                defaultMode: 0755              
+              {{- end }}         
             {{- if .Values.extraVolumes }}
             {{- include "openforms.tplvalues.render" ( dict "value" .Values.extraVolumes "context" $ ) | nindent 12 }}
             {{- end }}

charts/openforms/templates/cronjob-clean-logs.yaml

@@ -366,12 +366,12 @@ settings:
   escapeRegistrationOutput: false
 
   cleanLogs:
-    # -- Clean Logs, Messages, Timelog Entries
+    # -- Clean Timeline Log entries
     enabled: false
     # -- Number of days to retain logs
     daysRetained: 90
     cronjob:
-      # -- Schedule to run the clean logs cronjob
+      # -- Schedule to run the clean logs cronjob. The default will run the job every day at 00:00
       schedule: "0 0 * * *"
       historyLimit: 1
       resources: {}