vlogs: added option for retention by disk usage (#1846)

VictoriaMetrics · Dec 4, 2024 · f502b62 · f502b62
1 parent a20dc03
commit f502b62
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 2 deletions.
diff --git a/charts/victoria-logs-single/CHANGELOG.md b/charts/victoria-logs-single/CHANGELOG.md
@@ -1,6 +1,6 @@
 ## Next release
 
-- TODO
+- added `server.retentionDiskUsage` to control [retention by disk space](https://docs.victoriametrics.com/victorialogs/#retention-by-disk-space-usage). See [this issue](https://github.com/VictoriaMetrics/helm-charts/issues/1845)
 
 ## 0.8.9
 

diff --git a/charts/victoria-logs-single/README.md b/charts/victoria-logs-single/README.md
@@ -850,6 +850,17 @@ timeoutSeconds: 5
 </pre>
 </td>
       <td><p>Resource object. Details are <a href="http://kubernetes.io/docs/user-guide/compute-resources/" target="_blank">here</a></p>
+</td>
+    </tr>
+    <tr>
+      <td>server.retentionDiskSpaceUsage</td>
+      <td>string</td>
+      <td><pre class="helm-vars-default-value" language-yaml" lang="">
+<code class="language-yaml">""
+</code>
+</pre>
+</td>
+      <td><p>Data retention max capacity. Default unit is GiB. See these <a href="https://docs.victoriametrics.com/victorialogs/#retention-by-disk-space-usage" target="_blank">docs</a></p>
 </td>
     </tr>
     <tr>

diff --git a/charts/victoria-logs-single/templates/_helpers.tpl b/charts/victoria-logs-single/templates/_helpers.tpl
@@ -2,7 +2,20 @@
   {{- $Values := (.helm).Values | default .Values }}
   {{- $app := $Values.server -}}
   {{- $args := default dict -}}
-  {{- $_ := set $args "retentionPeriod" $app.retentionPeriod -}}
+  {{- if and (empty $app.retentionPeriod) (empty $app.retentionDiskSpaceUsage) -}}
+    {{- fail "either .Values.server.retentionPeriod or .Values.server.retentionDiskSpaceUsage should be defined" -}}
+  {{- end -}}
+  {{- with $app.retentionPeriod -}}
+    {{- $_ := set $args "retentionPeriod" $app.retentionPeriod -}}
+  {{- end -}}
+  {{- with $app.retentionDiskSpaceUsage -}}
+    {{- $retentionDiskSpaceUsage := int $app.retentionDiskSpaceUsage -}}
+    {{- if $retentionDiskSpaceUsage -}}
+      {{- $_ := set $args "retention.maxDiskSpaceUsageBytes" (printf "%dGiB" $retentionDiskSpaceUsage) -}}
+    {{- else -}}
+      {{- $_ := set $args "retention.maxDiskSpaceUsageBytes" $app.retentionDiskSpaceUsage -}}
+    {{- end -}}
+  {{- end -}}
   {{- $_ := set $args "storageDataPath" $app.persistentVolume.mountPath -}}
   {{- $args = mergeOverwrite $args (fromYaml (include "vm.license.flag" .)) -}}
   {{- $args = mergeOverwrite $args $app.extraArgs -}}

diff --git a/charts/victoria-logs-single/values.yaml b/charts/victoria-logs-single/values.yaml
@@ -51,6 +51,8 @@ server:
   priorityClassName: ""
   # -- Data retention period. Possible units character: h(ours), d(ays), w(eeks), y(ears), if no unit character specified - month. The minimum retention period is 24h. See these [docs](https://docs.victoriametrics.com/victorialogs/#retention)
   retentionPeriod: 1
+  # -- Data retention max capacity. Default unit is GiB. See these [docs](https://docs.victoriametrics.com/victorialogs/#retention-by-disk-space-usage)
+  retentionDiskSpaceUsage: ""
   # -- Extra command line arguments for container of component
   extraArgs:
     envflag.enable: true