vlagent: support logs collection

Author: AndrewChubatiuk

api/operator/v1/vlagent_types.go

@@ -73,6 +73,9 @@ type VLAgentSpec struct {
 	// +optional
 	SyslogSpec *SyslogServerSpec `json:"syslogSpec,omitempty"`
 
+	// K8sCollector configures VLAgent logs collection from K8s pods
+	K8sCollector VLAgentK8sCollector `json:"k8sCollector,omitempty"`
+
 	// ServiceAccountName is the name of the ServiceAccount to use to run the pods
 	// +optional
 	ServiceAccountName string `json:"serviceAccountName,omitempty"`
@@ -82,6 +85,38 @@ type VLAgentSpec struct {
 	vmv1beta1.CommonApplicationDeploymentParams `json:",inline,omitempty"`
 }
 
+type VLAgentK8sCollector struct {
+	// Enabled switches VLAgent to log collection mode.
+	// Note, for this purpose operator uses DaemonSet, while by default VLAgent uses StatefulSet.
+	// It means that switching this option will drop all persisted data.
+	Enabled bool `json:"enabled,omitempty"`
+
+	// LogsPath configures root for logs path
+	// By default VLAgent collects logs from /var/log/containers
+	LogsPath string `json:"logsPath,omitempty"`
+
+	// CheckpointsPath configures path where logs checkpoints are stored
+	CheckpointsPath string `json:"checkpointsPath,omitempty"`
+
+	// TenantID defines default tenant ID to use for logs collected from pods in format: <accountID>:<projectID>
+	TenantID string `json:"tenantID,omitempty"`
+
+	// IgnoreFields defines fields to ignore across logs ingested from Kubernetes
+	IgnoreFields []string `json:"ignoreFields,omitempty"`
+
+	// DecolorizeFields defines fields to remove ANSI color codes across logs ingested from Kubernetes
+	DecolorizeFields []string `json:"decolorizeFields,omitempty"`
+
+	// MsgField defines fields that may contain the _msg field
+	MsgFields []string `json:"msgFields,omitempty"`
+
+	// TimeFields defines fields that may contain the _time field
+	TimeFields []string `json:"timeFields,omitempty"`
+
+	// ExtraFields defines extra fields to add to each collected log line
+	ExtraFields string `json:"extraFields,omitempty"`
+}
+
 // SetLastSpec implements objectWithLastAppliedState interface
 func (cr *VLAgent) SetLastSpec(prevSpec VLAgentSpec) {
 	cr.ParsedLastAppliedSpec = &prevSpec
@@ -298,6 +333,11 @@ func (cr *VLAgent) FinalAnnotations() map[string]string {
 	return v
 }
 
+// AsCRDOwner implements interface
+func (*VLAgent) AsCRDOwner() []metav1.OwnerReference {
+	return vmv1beta1.GetCRDAsOwner(vmv1beta1.VLAgentCRD)
+}
+
 // SelectorLabels returns selector labels for querying any vlagent related resources
 func (cr *VLAgent) SelectorLabels() map[string]string {
 	return map[string]string{
@@ -402,6 +442,10 @@ func (cr *VLAgent) ProbePort() string {
 	return cr.Spec.Port
 }
 
+func (cr *VLAgent) GetClusterRoleName() string {
+	return fmt.Sprintf("monitoring:%s:vlagent-%s", cr.Namespace, cr.Name)
+}
+
 // ProbeNeedLiveness implements build.probeCRD interface
 func (*VLAgent) ProbeNeedLiveness() bool {
 	return true

api/operator/v1/zz_generated.deepcopy.go

@@ -13,7 +13,8 @@ import (
 type CRDName int
 
 const (
-	Agent CRDName = iota
+	VMAgentCRD CRDName = iota
+	VLAgentCRD
 )
 
 func (c CRDName) String() string {
@@ -39,7 +40,9 @@ func Init(ctx context.Context, rclient client.Client) error {
 		var n CRDName
 		switch item.Name {
 		case "vmagents.operator.victoriametrics.com":
-			n = Agent
+			n = VMAgentCRD
+		case "vlagents.operator.victoriametrics.com":
+			n = VLAgentCRD
 		default:
 			continue
 		}

api/operator/v1beta1/owner.go

@@ -788,7 +788,7 @@ func (cr *VMAgent) AsURL() string {
 
 // AsCRDOwner implements interface
 func (*VMAgent) AsCRDOwner() []metav1.OwnerReference {
-	return GetCRDAsOwner(Agent)
+	return GetCRDAsOwner(VMAgentCRD)
 }
 
 func (cr *VMAgent) Probe() *EmbeddedProbes {

api/operator/v1beta1/vmagent_types.go

@@ -736,6 +736,58 @@ spec:
                   type: object
                   x-kubernetes-preserve-unknown-fields: true
                 type: array
+              k8sCollector:
+                description: K8sCollector configures VLAgent logs collection from
+                  K8s pods
+                properties:
+                  checkpointsPath:
+                    description: CheckpointsPath configures path where logs checkpoints
+                      are stored
+                    type: string
+                  decolorizeFields:
+                    description: DecolorizeFields defines fields to remove ANSI color
+                      codes across logs ingested from Kubernetes
+                    items:
+                      type: string
+                    type: array
+                  enabled:
+                    description: |-
+                      Enabled switches VLAgent to log collection mode.
+                      Note, for this purpose operator uses DaemonSet, while by default VLAgent uses StatefulSet.
+                      It means that switching this option will drop all persisted data.
+                    type: boolean
+                  extraFields:
+                    description: ExtraFields defines extra fields to add to each collected
+                      log line
+                    type: string
+                  ignoreFields:
+                    description: IgnoreFields defines fields to ignore across logs
+                      ingested from Kubernetes
+                    items:
+                      type: string
+                    type: array
+                  logsPath:
+                    description: |-
+                      LogsPath configures root for logs path
+                      By default VLAgent collects logs from /var/log/containers
+                    type: string
+                  msgFields:
+                    description: MsgField defines fields that may contain the _msg
+                      field
+                    items:
+                      type: string
+                    type: array
+                  tenantID:
+                    description: 'TenantID defines default tenant ID to use for logs
+                      collected from pods in format: <accountID>:<projectID>'
+                    type: string
+                  timeFields:
+                    description: TimeFields defines fields that may contain the _time
+                      field
+                    items:
+                      type: string
+                    type: array
+                type: object
               livenessProbe:
                 description: LivenessProbe that will be added CRD pod
                 type: object

config/crd/overlay/crd.yaml

@@ -0,0 +1,23 @@
+apiVersion: operator.victoriametrics.com/v1
+kind: VLAgent
+metadata:
+  name: example
+spec:
+  replicaCount: 2
+  resources:
+    requests:
+      cpu: "50m"
+      memory: "350Mi"
+    limits:
+      cpu: "500m"
+      memory: "850Mi"
+  persistentVolumeClaimRetentionPolicy:
+    whenDeleted: Delete
+  k8sCollector:
+    enabled: true
+  remoteWrite:
+    - url: "http://vlsingle-example-0.default.svc:9428/internal/insert"
+      maxDiskUsage: 10GB
+  remoteWriteSettings:
+    # ~ 5GB in bytes
+    maxBlockSize: 30MB

config/examples/vlagent-collector.yaml

@@ -14,6 +14,7 @@ aliases:
 ## tip
 
 * FEATURE: [vmagent](https://docs.victoriametrics.com/operator/resources/vmagent/): support `namespace` parameter in `attach_metadata` section for all scrape configurations. See [#1654](https://github.com/VictoriaMetrics/operator/issues/1654).
+* FEATURE: [vlagen](https://docs.victoriametrics.com/operator/resources/vlagent): support logs collection. See [#1501](https://github.com/VictoriaMetrics/operator/issues/1501).
 
 ## [v0.66.1](https://github.com/VictoriaMetrics/operator/releases/tag/v0.66.1)
 

docs/CHANGELOG.md

@@ -170,6 +170,27 @@ VLAgent - is a tiny but brave agent, which helps you collect logs from various s
 | spec<a href="#vlagent-spec" id="vlagent-spec">#</a><br/>_[VLAgentSpec](#vlagentspec)_ | _(Required)_<br/> |
 
 
+#### VLAgentK8sCollector
+
+
+
+
+
+Appears in: [VLAgentSpec](#vlagentspec)
+
+| Field | Description |
+| --- | --- |
+| checkpointsPath<a href="#vlagentk8scollector-checkpointspath" id="vlagentk8scollector-checkpointspath">#</a><br/>_string_ | _(Required)_<br/>CheckpointsPath configures path where logs checkpoints are stored |
+| decolorizeFields<a href="#vlagentk8scollector-decolorizefields" id="vlagentk8scollector-decolorizefields">#</a><br/>_string array_ | _(Required)_<br/>DecolorizeFields defines fields to remove ANSI color codes across logs ingested from Kubernetes |
+| enabled<a href="#vlagentk8scollector-enabled" id="vlagentk8scollector-enabled">#</a><br/>_boolean_ | _(Required)_<br/>Enabled switches VLAgent to log collection mode.<br />Note, for this purpose operator uses DaemonSet, while by default VLAgent uses StatefulSet.<br />It means that switching this option will drop all persisted data. |
+| extraFields<a href="#vlagentk8scollector-extrafields" id="vlagentk8scollector-extrafields">#</a><br/>_string_ | _(Required)_<br/>ExtraFields defines extra fields to add to each collected log line |
+| ignoreFields<a href="#vlagentk8scollector-ignorefields" id="vlagentk8scollector-ignorefields">#</a><br/>_string array_ | _(Required)_<br/>IgnoreFields defines fields to ignore across logs ingested from Kubernetes |
+| logsPath<a href="#vlagentk8scollector-logspath" id="vlagentk8scollector-logspath">#</a><br/>_string_ | _(Required)_<br/>LogsPath configures root for logs path<br />By default VLAgent collects logs from /var/log/containers |
+| msgFields<a href="#vlagentk8scollector-msgfields" id="vlagentk8scollector-msgfields">#</a><br/>_string array_ | _(Required)_<br/>MsgField defines fields that may contain the _msg field |
+| tenantID<a href="#vlagentk8scollector-tenantid" id="vlagentk8scollector-tenantid">#</a><br/>_string_ | _(Required)_<br/>TenantID defines default tenant ID to use for logs collected from pods in format: <accountID>:<projectID> |
+| timeFields<a href="#vlagentk8scollector-timefields" id="vlagentk8scollector-timefields">#</a><br/>_string array_ | _(Required)_<br/>TimeFields defines fields that may contain the _time field |
+
+
 #### VLAgentRemoteWriteSettings
 
 
@@ -236,6 +257,7 @@ Appears in: [VLAgent](#vlagent)
 | image<a href="#vlagentspec-image" id="vlagentspec-image">#</a><br/>_[Image](#image)_ | _(Optional)_<br/>Image - docker image settings<br />if no specified operator uses default version from operator config |
 | imagePullSecrets<a href="#vlagentspec-imagepullsecrets" id="vlagentspec-imagepullsecrets">#</a><br/>_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core) array_ | _(Optional)_<br/>ImagePullSecrets An optional list of references to secrets in the same namespace<br />to use for pulling images from registries<br />see https://kubernetes.io/docs/concepts/containers/images/#referring-to-an-imagepullsecrets-on-a-pod |
 | initContainers<a href="#vlagentspec-initcontainers" id="vlagentspec-initcontainers">#</a><br/>_[Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#container-v1-core) array_ | _(Optional)_<br/>InitContainers allows adding initContainers to the pod definition.<br />Any errors during the execution of an initContainer will lead to a restart of the Pod.<br />More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
+| k8sCollector<a href="#vlagentspec-k8scollector" id="vlagentspec-k8scollector">#</a><br/>_[VLAgentK8sCollector](#vlagentk8scollector)_ | _(Required)_<br/>K8sCollector configures VLAgent logs collection from K8s pods |
 | logFormat<a href="#vlagentspec-logformat" id="vlagentspec-logformat">#</a><br/>_string_ | _(Optional)_<br/>LogFormat for VLAgent to be configured with. |
 | logLevel<a href="#vlagentspec-loglevel" id="vlagentspec-loglevel">#</a><br/>_string_ | _(Optional)_<br/>LogLevel for VLAgent to be configured with.<br />INFO, WARN, ERROR, FATAL, PANIC |
 | managedMetadata<a href="#vlagentspec-managedmetadata" id="vlagentspec-managedmetadata">#</a><br/>_[ManagedObjectsMetadata](#managedobjectsmetadata)_ | _(Required)_<br/>ManagedMetadata defines metadata that will be added to the all objects<br />created by operator for the given CustomResource |

docs/api.md

@@ -1,7 +1,7 @@
 | Environment variables |
 | --- |
 | VM_METRICS_VERSION: `v1.131.0` <a href="#variables-vm-metrics-version" id="variables-vm-metrics-version">#</a> |
-| VM_LOGS_VERSION: `v1.36.1` <a href="#variables-vm-logs-version" id="variables-vm-logs-version">#</a> |
+| VM_LOGS_VERSION: `v1.40.0` <a href="#variables-vm-logs-version" id="variables-vm-logs-version">#</a> |
 | VM_ANOMALY_VERSION: `v1.26.1` <a href="#variables-vm-anomaly-version" id="variables-vm-anomaly-version">#</a> |
 | VM_TRACES_VERSION: `v0.5.0` <a href="#variables-vm-traces-version" id="variables-vm-traces-version">#</a> |
 | VM_OPERATOR_VERSION: `v0.65.0` <a href="#variables-vm-operator-version" id="variables-vm-operator-version">#</a> |

docs/env.md

@@ -136,6 +136,14 @@ then `VLAgent` pods will be created without resource requests and limits.
 
 Also, you can specify requests without limits - in this case default values for limits will not be used.
 
+## K8s logs collection
+
+VLAgent supports collecting logs from K8s pods. To enable it it's required to set `spec.k8sCollector.enabled: true`.
+With this setting operator:
+ - switches VLAgent to DaemonSet mode
+ - mounts host paths, where k8s logs are stored
+ - adds RBAC to be able to get pods, namespaces and nodes information using K8s API
+
 ## Storage management
 
 In case of errors sending logs to `remoteWrite`,