Skip to content

Commit fe71ff0

Browse files
vadimalekseevvadimalekseev
committed
add victoria-logs-agent helm chart
1 parent 9eeaa1c commit fe71ff0

File tree

14 files changed

+677
-0
lines changed

14 files changed

+677
-0
lines changed

‎charts/victoria-logs-agent/.helmignore‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Patterns to ignore when building packages.
2+
# This supports shell glob matching, relative path matching, and
3+
# negation (prefixed with !). Only one pattern per line.
4+
.DS_Store
5+
# Common VCS dirs
6+
.git/
7+
.gitignore
8+
.bzr/
9+
.bzrignore
10+
.hg/
11+
.hgignore
12+
.svn/
13+
# Common backup files
14+
*.swp
15+
*.bak
16+
*.tmp
17+
*~
18+
# Various IDEs
19+
.project
20+
.idea/
21+
*.tmproj
22+
.vscode/
23+
*.md.gotmpl
24+
CHANGELOG.md
25+
_changelog.md
26+
_index.md
27+
e2e/
28+
lint/
29+
tests/

‎charts/victoria-logs-agent/CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Next release
2+
3+
- charts/victoria-logs-agent: add new chart

‎charts/victoria-logs-agent/Chart.lock‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
dependencies:
2+
- name: victoria-metrics-common
3+
repository: https://victoriametrics.github.io/helm-charts
4+
version: 0.0.42
5+
digest: sha256:dfa78bd40154cb14f4638f4e8b130730a2d05c0d22cf38a220af070fefcd391e
6+
generated: "2025-07-11T12:36:42.838849+04:00"

‎charts/victoria-logs-agent/Chart.yaml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
apiVersion: v2
2+
type: application
3+
appVersion: v1.36.1
4+
name: victoria-logs-agent
5+
description: VictoriaLogs Agent - accepts logs from various protocols and replicates them across multiple VictoriaLogs instances.
6+
version: 0.0.1
7+
sources:
8+
- https://github.com/VictoriaMetrics/helm-charts
9+
icon: https://avatars.githubusercontent.com/u/43720803?s=200&v=4
10+
kubeVersion: ">=1.25.0-0"
11+
home: https://github.com/VictoriaMetrics/helm-charts
12+
keywords:
13+
- victorialogs
14+
- logs
15+
- agent
16+
- collector
17+
- kubernetes
18+
- observability
19+
annotations:
20+
artifacthub.io/license: Apache-2.0
21+
artifacthub.io/category: "monitoring-logging"
22+
artifacthub.io/links: |
23+
- name: Sources
24+
url: https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-logs-agent
25+
- name: Charts repo
26+
url: https://victoriametrics.github.io/helm-charts/
27+
- name: Changelog
28+
url: https://docs.victoriametrics.com/changelog/
29+
dependencies:
30+
- name: victoria-metrics-common
31+
version: "0.0.*"
32+
repository: https://victoriametrics.github.io/helm-charts

‎charts/victoria-logs-agent/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# VictoriaLogs Agent Helm chart
2+
3+
Chart documentation is available [here](https://docs.victoriametrics.com/helm/victoria-logs-agent/)

‎charts/victoria-logs-agent/_changelog.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
title: CHANGELOG
2+
menu:
3+
docs:
4+
weight: 1
5+
identifier: helm-victorialogs-agent-changelog
6+
parent: helm-victorialogs-agent
7+
url: /helm/victorialogs-agent/changelog
8+
aliases:
9+
- /helm/victorialogs-agent/changelog/index.html
10+
tags:
11+
- logs
12+
- kubernetes
13+
---
14+
{{% content "CHANGELOG.md" %}}

‎charts/victoria-logs-agent/_index.md.gotmpl‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
weight: 2
3+
title: VictoriaLogs Agent
4+
menu:
5+
docs:
6+
parent: helm
7+
weight: 2
8+
identifier: helm-victorialogs-agent
9+
url: /helm/victoria-logs-agent
10+
aliases:
11+
- /helm/victorialogs-agent/index.html
12+
- /helm/victorialogs-agent/
13+
tags:
14+
- logs
15+
- kubernetes
16+
---
17+
{{ template "chart.badges" . }}
18+
19+
{{ template "chart.description" . }}
20+
21+
{{ template "chart.prerequisites" . }}
22+
## Quick start
23+
24+
This Helm chart deploys the log receiver agent as a StatefulSet or Deployment (configurable via values in the chart).
25+
It receives logs using [supported protocols](https://docs.victoriametrics.com/victorialogs/data-ingestion/)
26+
(for example: syslog, Elasticsearch, OpenTelemetry) from cluster workloads and forwards them to the configured VictoriaLogs destinations.
27+
If more than one destination is specified, collected logs are replicated to all configured destinations.
28+
29+
- To quickly install single-node version of VictoriaLogs and `victoria-logs-agent`, see [these docs](https://docs.victoriametrics.com/helm/victoria-logs-single/#quick-start).
30+
- To start with a VictoriaLogs cluster and `victoria-logs-agent`, see [these docs](https://docs.victoriametrics.com/helm/victoria-logs-cluster/#quick-start).
31+
32+
## Chart configuration
33+
34+
The simplest working configuration includes specifying the `remoteWrite` array and setting CPU and memory resources for the chart.
35+
36+
Example of a minimal working configuration:
37+
38+
```yaml
39+
remoteWrite:
40+
- url: http://victoria-logs:9428
41+
42+
resources:
43+
limits:
44+
cpu: 100m
45+
memory: 128Mi
46+
requests:
47+
cpu: 100m
48+
memory: 128Mi
49+
```
50+
51+
If multiple `remoteWrite` entries are defined, logs are replicated to all the specified destinations.
52+
53+
### Basic auth
54+
55+
If you need to use basic auth, define the secrets via environment variables and fill out the `basicAuth` object as shown below:
56+
57+
```yaml
58+
remoteWrite:
59+
- url: http://victoria-logs:9428
60+
basicAuth:
61+
passwordEnvKey: 'VL_PASSWORD'
62+
usernameEnvKey: 'VL_USERNAME'
63+
64+
env:
65+
- name: VL_PASSWORD
66+
valueFrom:
67+
secretKeyRef:
68+
name: auth-secret
69+
key: VL_PASSWORD
70+
- name: VL_USERNAME
71+
valueFrom:
72+
secretKeyRef:
73+
name: auth-secret
74+
key: VL_USERNAME
75+
```
76+
77+
### Multitenancy
78+
79+
To define [tenant](https://docs.victoriametrics.com/victorialogs/#multitenancy), use `projectID` and `accountID` as shown below:
80+
81+
```yaml
82+
remoteWrite:
83+
- url: http://localhost:9428
84+
projectID: 12
85+
accountID: 42
86+
```
87+
88+
### TLS
89+
90+
To enable TLS verification for the remoteWrite target, you can specify the `tls` block inside each remoteWrite entry.
91+
92+
At a minimum, you should provide the `caFile` path so that the agent can verify the server's TLS certificate.
93+
This is useful when the target endpoint uses a certificate signed by a custom or self-signed Certificate Authority (CA).
94+
95+
```yaml
96+
remoteWrite:
97+
- url: https://victoria-logs:9428
98+
tls:
99+
caFile: "/etc/tls/ca.crt"
100+
101+
extraVolumes:
102+
- name: tls-certs
103+
secret:
104+
secretName: tls-secret
105+
106+
extraVolumeMounts:
107+
- name: tls-certs
108+
mountPath: /etc/tls
109+
readOnly: true
110+
```
111+
112+
If you want to disable TLS certificate verification (not recommended in production), you can set `insecureSkipVerify` to true.
113+
114+
This will skip verification of the server's certificate and allow connecting to targets with self-signed or invalid certificates.
115+
116+
```yaml
117+
remoteWrite:
118+
- url: https://victoria-logs:9428
119+
tls:
120+
insecureSkipVerify: true
121+
```
122+
123+
### Ignore fields
124+
125+
VictoriaLogs efficiently compresses repeated values, such as pod and node labels.
126+
However, if you prefer not to store certain fields, you can ignore them using the `ignoreFields` option.
127+
For example:
128+
129+
```yaml
130+
remoteWrite:
131+
- url: http://victoria-logs:9428
132+
ignoreFields:
133+
- file
134+
- kubernetes.container_id
135+
- kubernetes.pod_annotations*
136+
- kubernetes.node_labels*
137+
- kubernetes.namespace_labels*
138+
- kubernetes.pod_labels*
139+
```
140+
141+
This allows you to exclude unnecessary or sensitive fields from being ingested.
142+
If sensitive data has already been ingested, see how to
143+
[exclude logs from search result](https://docs.victoriametrics.com/victorialogs/security-and-lb/#access-control-inside-a-single-tenant).
144+
145+
### Extra fields
146+
147+
You can add custom fields to your logs by including the `extraFields` section in your configuration.
148+
For example:
149+
150+
```yaml
151+
remoteWrite:
152+
- url: http://victoria-logs:9428/
153+
extraFields:
154+
zone: us-east1-c
155+
source: victoria-logs-agent
156+
```
157+
158+
This feature lets you attach metadata to every log entry,
159+
making it easier to filter, group, or analyze logs based on these additional attributes.
160+
161+
{{ include "chart.installSection" . }}
162+
163+
{{ include "chart.uninstallSection" . }}
164+
165+
{{ include "chart.helmDocs" . }}
166+
167+
## Parameters
168+
169+
The following tables lists the configurable parameters of the chart and their default values.
170+
171+
Change the values according to the need of the environment in ``victoria-logs-agent/values.yaml`` file.
172+
173+
{{ template "chart.valuesTableHtml" . }}

‎charts/victoria-logs-agent/e2e/simple.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
mode: deployment
2+
3+
remoteWrite:
4+
- url: "http://victorialogs:9429"

‎charts/victoria-logs-agent/templates/NOTES.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
To view running VictoriaLogs agents:
2+
kubectl get po -o wide -l app.kubernetes.io/name={{ include "victoria-logs-agent.fullname" . }} -n {{ .Release.Namespace }}

‎charts/victoria-logs-agent/templates/_helpers.tpl‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
{{- define "victoria-logs-agent.fullname" }}
2+
{{- if .Values.fullnameOverride }}
3+
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
4+
{{- else }}
5+
{{- $name := default .Chart.Name .Values.nameOverride }}
6+
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
7+
{{- end }}
8+
{{- end }}
9+
10+
{{- define "vlagent.args" -}}
11+
{{- $args := default dict -}}
12+
{{- $_ := set $args "remoteWrite.maxDiskUsagePerURL" .Values.maxDiskUsagePerURL -}}
13+
{{- $_ := set $args "remoteWrite.tmpDataPath" "/vlagent-remotewrite-data" -}}
14+
{{- $args = mergeOverwrite $args (fromYaml (include "vm.license.flag" .)) -}}
15+
{{- toYaml (fromYaml (include "vm.args" $args)).args -}}
16+
{{- end -}}
17+
18+
{{- define "vlagent.remoteWriteArgs" -}}
19+
{{- if empty .Values.remoteWrite }}
20+
{{- fail "'remoteWrite' list is empty; at least one remoteWrite configuration must be provided" }}
21+
{{- end }}
22+
{{- $args := list }}
23+
{{- $knownFields := list "url" "basicAuth" "accountID" "projectID" "tls" "extraFields" "ignoreFields" "msgField" "streamFields" }}
24+
{{- range $i, $rw := .Values.remoteWrite }}
25+
{{- /* Validate remoteWrite object */ -}}
26+
{{- if empty $rw.url }}
27+
{{ fail (printf "'url' field must be set for remoteWrite[%d]" $i) }}
28+
{{- end }}
29+
{{- range $rwKey, $_ := $rw }}
30+
{{- if not (has $rwKey $knownFields) }}
31+
{{- fail (printf "unknown field %q for remoteWrite[%d]" $rwKey $i) }}
32+
{{- end }}
33+
{{- end }}
34+
35+
{{- $args = append $args (printf "--remoteWrite.url=%s/internal/insert" (trimSuffix "/" $rw.url)) }}
36+
37+
{{- $headers := list }}
38+
{{- $headers = append $headers (printf "AccountID:%v" ($rw.accountID | default "0")) }}
39+
{{- $headers = append $headers (printf "ProjectID:%v" ($rw.projectID | default "0")) }}
40+
{{- if not (empty $rw.streamFields) }}
41+
{{- $headers = append $headers (printf "VL-Stream-Fields:%s" (join "," $rw.streamFields)) }}
42+
{{- end }}
43+
{{- if not (empty $rw.msgField) }}
44+
{{- $headers = append $headers (printf "VL-Msg-Field:%s" (join "," $rw.msgField)) }}
45+
{{- end }}
46+
{{- if not (empty $rw.timeField) }}
47+
{{- $headers = append $headers (printf "VL-Time-Field:%s" (join "," $rw.timeField)) }}
48+
{{- end }}
49+
{{- if not (empty $rw.ignoreFields) }}
50+
{{- $headers = append $headers (printf "VL-Ignore-Fields:%s" (join "," $rw.ignoreFields)) }}
51+
{{- end }}
52+
53+
{{- with $rw.extraFields }}
54+
{{- $pairs := list }}
55+
{{- range $k, $v := . }}
56+
{{- $pairs = append $pairs (printf "%s=%s" $k $v) }}
57+
{{- end }}
58+
{{- $headers = append $headers (printf "VL-Extra-Fields:%s" ($pairs | join ",")) }}
59+
{{- end }}
60+
{{- $args = append $args (printf "--remoteWrite.headers=%q" ($headers | join "^^")) }}
61+
{{- end }}
62+
{{- toYaml $args -}}
63+
{{- end -}}

0 commit comments

Comments
 (0)