Configure Sysdig Linux Agent

Follow the instructions on this page to implement configurations found in the Configuration Library.

For the latest Helm-based configuration options, see sysdig-deploy.

Modify the dragent.yaml file to configure the agent. How you configure dragent.yaml depends on whether the agent was installed:

• In a Kubernetes environment.
• In a non-orchestrated container, such as a Docker.
• As a Linux package.

Kubernetes

If Sysdig agent is installed in a Kubernetes environment with Helm, you can edit the dragent.yaml with Helm.

To edit dragent.yaml with Helm, you can:

• Add configuration to values.yaml.
• Use key-values as inline arguments with helm install.

For example, to edit dragent.yaml in Helm syntax:

helm install sysdig-agent \
  --namespace sysdig-agent \
  --set global.clusterConfig.name='my_cluster' \
  --set global.sysdig.tags.{tag_name_1}={tag_value_1} \
  --set global.sysdig.tags.{tag_name_2}={tag_value_2} \
  --set global.sysdig.tags.{tag_name_3}={tag_value_3} \
  sysdig/sysdig-deploy

where for each tag_name you have a specific tag_value like:

helm install sysdig-agent \
  --namespace sysdig-agent \
  --set global.clusterConfig.name='my_cluster' \
  --set global.sysdig.tags.linux=ubuntu \
  --set global.sysdig.tags.dept=dev \
  --set global.sysdig.tags.local=nyc \
  sysdig/sysdig-deploy

This command will be translated into the following:

data:
  dragent.yaml: |
    tags: linux:ubuntu,dept:dev,local:nyc
    k8s_cluster_name: my_cluster    

For more details, including instruction on utilizing values.yaml see Sysdig Deploy.

Container

If Sysdig agent is installed in a non-orchestrated environment such as Docker, you can edit the dragent.yaml file in one or more of the following ways:

• Mount the dragent.yaml file as a Docker volume inside the container.

  docker run -v /home/admin-user/config-files/sysdig-agent/dragent.yaml:/opt/draios/etc/dragent.yaml ... quay.io/sysdig/agent
  

• Pass parameters that will be appended to a dynamically generated dragent.yaml file via the ADDITIONAL_CONF environment variable.

  docker run -e ADDITIONAL_CONF="<dragent.yaml parameters>" ... quay.io/sysdig/agent
  

  If dragent.yaml is mounted as a Docker volume inside the container, the ADDITIONAL_CONF environment variable will be ignored.

• Use environment variables such as COLLECTOR, ACCESS_KEY, TAGS, and so on to add or override specific parameters in dragent.yaml.

• Pass environment variables directly to the agent such as SYSDIG_AGENT_DRIVER or SYSDIG_BPF_PROBE.

Edit dragent.yaml

1. Mount dragent.yaml as a container.

2. Log in to the host where the agent is installed.

3. Locate and open dragent.yaml.

   If dragent.yaml is mounted inside an agent container as a Docker volume, it may be located anywhere on the host that the administrator finds convenient.

4. Edit the file using proper YAML syntax. See Examples.

5. For changes to take effect, restart the agent with the command:

   docker restart sysdig-agent
   

docker run

Use the docker run command with -e ADDITIONAL_CONF="<VARIABLES>" where <VARIABLES> contains all the customized parameters you want to include.

Convert YAML Parameters to Single-Line Format

To insert ADDITIONAL_CONF parameters in a docker run command or a DaemonSet file, you must convert the YAML code into a single line. You can do the conversion manually for short snippets. To convert longer portions of YAML, use echo|sed commands:

1. Write your configuration in YAML, as it would be entered directly in dragent.yaml.

2. In a Bash shell, use echo and sed to convert to a single line:

   echo '<YAML_CONTENT>' | sed -e ':a' -e 'N' -e '$!ba' -e 's/\n/\\n/g'
   

3. Insert the resulting line into the docker run command or add it to the DaemonSet file as an ADDITIONAL_CONF.

Linux

If the Sysdig agent is installed in a Linux host via a .rpm or .deb package, edit dragent.yaml directly.

• On .rpm installations, environment variables may be specified in /etc/sysconfig/dragent.

• On .deb installations, environment variables may be specified in /etc/default/dragent.

The systemd supervisor does not support inline comments for environment variables. If you edit the file after setup, do not write comments on the same line where you define the environment variable.

The agent and its probe-loader shell script understand the following environment variables:

• SYSDIG_AGENT_DRIVER (12.17.0 and newer)
• SYSDIG_BPF_PROBE

Use one of the following:

• Agent version 12.17.0 or newer

  SYSDIG_AGENT_DRIVER=universal_ebpf
  

• Agent versions before 12.17.0

  export SYSDIG_BPF_PROBE=""
  

This environment file is sourced directly by the agent init script. For agent versions before 12.17.0, the export keyword is required.

Edit dragent.yaml

1. Log in to the host where the agent is installed.

2. Open /opt/draios/etc/dragent.yaml.

3. Edit the file using proper YAML syntax. See Examples.

4. For changes to take effect, restart the agent with the command:

   service dragent restart
   

Environment Variables Used by Entry Point Script for Non-Orchestrated Containers

Environment Variables Used by the Agent Probe-Loader Shell Script

Here is a sample Docker command using environment variables in an on-prem environment with a self-signed certificate:

docker run \
  --name sysdig-agent \
  --privileged \
  --net host \
  --pid host \
  -e ACCESS_KEY=<ACCESS_KEY> \
  -e COLLECTOR=<ONPREM_COLLECTOR_HOST> \
  -e COLLECTOR_PORT=6443 \
  -e CHECK_CERTIFICATE=false \
  -e TAGS=my_tag:some_value \
  -e ADDITIONAL_CONF="log:\n file_priority: debug\n console_priority: error" \
  -v /var/run/docker.sock:/host/var/run/docker.sock \
  -v /dev:/host/dev \
  -v /proc:/host/proc:ro \
  -v /boot:/host/boot:ro \
  -v /lib/modules:/host/lib/modules:ro \
  -v /usr:/host/usr:ro \
  --shm-size=350m \
  quay.io/sysdig/agent