Introduction

Datasources

To be able to monitor applications, the Security Engine needs to access logs. DataSources are configured via the acquisition configuration, or specified via the command-line when performing cold logs analysis.

Name	Type	Stream	One-shot
file	single files, glob expressions and .gz files	yes	yes
journald	journald via filter	yes	yes
AWS cloudwatch	single stream or log group	yes	yes
syslog service	read logs received via syslog protocol	yes	no
docker	read logs from docker containers	yes	yes
AWS kinesis	read logs from a kinesis strean	yes	no
Kafka	read logs from kafka topic	yes	no
Windows Event	read logs from windows event log	yes	no
Kubernetes Audit	expose a webhook to receive audit logs from a Kubernetes cluster	yes	no
S3	read logs from a S3 bucket	yes	yes

Common configuration parameters

Those parameters are available in all datasources.

log_level

Log level to use in the datasource. Defaults to info.

source

Which type of datasource to use. It is mandatory except for file acquisition.

transform

An expression that will run after the acquisition has read one line, and before the line is sent to the parsers.

It allows to modify an event (or generate multiple events from one line) before parsing.

For example, if you acquire logs from a file containing a JSON object on each line, and each object has a Records array with multiple events, you can use the following to generate one event per entry in the array:

map(JsonExtractSlice(evt.Line.Raw, "Records"), ToJsonString(#))

The expression must return:

• A string: it will replace evt.Line.Raw in the event
• A list of strings: One new event will be generated based on the source event per element in the list. Each element will replace the evt.Line.Raw from the source event.

If the expression returns an error or an invalid type, the event will not be modified before sending it to the parsers.

labels

A map of labels to add to the event. The type label is mandatory, and used by the Security Engine to choose which parser to use.

Acquisition configuration example

/etc/crowdsec/acquis.yaml

filenames:
  - /var/log/nginx/*.log
labels:
  type: nginx
---
filenames:
 - /var/log/auth.log
 - /var/log/syslog
labels:
  type: syslog
---
source: docker
container_name_regexp:
 - .*caddy*
labels:
  type: caddy
---
...

warning

The labels and type fields are necessary to dispatch the log lines to the right parser.

Also note between each datasource is --- this is needed to separate multiple YAML documents (each datasource) in a single file.