Install the LogFlux Agent

The LogFlux Agent is a plugin-based log collection and forwarding system. It includes a core daemon that manages plugins for different log sources.

Quick Install

Debian / Ubuntu (APT)

1
curl -fsSL https://download.logflux.io/apt/install.sh | sudo bash

Or manually:

1
2
3
4
5
6
7
8
curl -fsSL https://download.logflux.io/apt/logflux.gpg \
  | sudo gpg --dearmor -o /usr/share/keyrings/logflux-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/logflux-archive-keyring.gpg] \
  https://download.logflux.io/apt stable main" \
  | sudo tee /etc/apt/sources.list.d/logflux.list

sudo apt update && sudo apt install -y logflux-agent

RHEL / CentOS / Rocky / Alma (RPM)

1
curl -fsSL https://download.logflux.io/rpm/install.sh | sudo bash

Or manually:

1
2
3
4
sudo curl -fsSL https://download.logflux.io/rpm/logflux.repo \
  -o /etc/yum.repos.d/logflux.repo

sudo dnf install -y logflux-agent

macOS (Homebrew)

1
brew install logflux-io/tap/logflux-agent

Binary Download (Linux / macOS)

1
2
3
# Download and extract (Linux amd64 example)
curl -fsSL https://download.logflux.io/agent/linux/latest/logflux-agent-linux-amd64.tar.gz | tar xz
sudo mv logflux-agent logflux-metrics logflux-filestream /usr/local/bin/

Binary Download (Windows)

1
2
3
# Download and extract
Invoke-WebRequest -Uri "https://download.logflux.io/agent/windows/latest/logflux-agent-windows-amd64.zip" -OutFile logflux-agent.zip
Expand-Archive logflux-agent.zip -DestinationPath C:\logflux-agent

Add C:\logflux-agent to your PATH. Configure in C:\logflux-agent\agent.yaml. See the Windows Event Log integration for Windows-specific log collection.

All binaries and checksums are available at download.logflux.io.

Docker

1
docker run -v /etc/logflux-agent:/etc/logflux-agent logflux/logflux-agent:latest

Quick Start

1. Configure API Key

1
sudo nano /etc/logflux-agent/agent.yaml

Set your API key:

1
api_key: your-api-key-here

2. Start Services

1
2
3
4
5
6
7
8
# Start the main agent daemon
sudo systemctl enable --now logflux-agent

# Start the metrics collector
sudo systemctl enable --now logflux-agent-metrics

# Start the journal collector (Linux only)
sudo systemctl enable --now logflux-agent-journald

3. Verify

1
2
sudo systemctl status logflux-agent
sudo journalctl -u logflux-agent -f

Components

The agent package includes:

Binary	Purpose	Systemd Service
`logflux-agent`	Core daemon, queue, forwarding	`logflux-agent.service`
`logflux-metrics`	CPU, memory, disk, network metrics	`logflux-agent-metrics.service`
`logflux-journald`	systemd journal collection (Linux)	`logflux-agent-journald.service`
`logflux-filestream`	File monitoring with rotation detection	-

Plugins communicate with the daemon over a local Unix socket. Each plugin runs as a separate process and systemd service.

Configuration

Main Configuration

/etc/logflux-agent/agent.yaml:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
api_key: your-api-key-here
server_url: /var/run/logflux-agent/agent.sock
node: my-server

queue:
  type: sqlite
  database_path: /var/lib/logflux-agent/queue.db
  max_size: 10000

batch:
  size: 100
  flush_interval: 5s

workers: 4

Plugin Configuration

Plugin configs are in /etc/logflux-agent/plugins/:

metrics.yaml – Collection interval, enabled collectors
journald.yaml – Journal filters, unit patterns
filestream.yaml – Watched paths, rotation handling

Configuration Priority

Command-line flags
Config file (-config path)
/etc/logflux-agent/agent.yaml
/etc/logflux-agent/plugins/<name>.yaml
Built-in defaults

Data Flow

Plugins --> Unix socket --> Agent daemon --> SQLite queue --> Batch worker --> AES-256-GCM encryption --> Ingestor

All log data is encrypted locally before transmission. The LogFlux backend never sees plaintext logs.

Supported Platforms

Platform	Architectures	Install Methods
Ubuntu 20.04+	amd64, arm64	APT, binary, Docker
Debian 10+	amd64, arm64	APT, binary, Docker
RHEL/CentOS/Rocky 8+	x86_64, aarch64	RPM, binary, Docker
Fedora 38+	x86_64, aarch64	RPM, binary, Docker
Amazon Linux 2+	x86_64, aarch64	RPM, binary, Docker
macOS 10.15+	Intel, Apple Silicon	Homebrew, binary
Windows 10+	x86_64, arm64	Binary (zip)

Uninstall

APT

1
2
3
sudo systemctl stop logflux-agent logflux-agent-metrics logflux-agent-journald
sudo apt remove logflux-agent
sudo rm /etc/apt/sources.list.d/logflux.list

RPM

1
2
3
sudo systemctl stop logflux-agent logflux-agent-metrics logflux-agent-journald
sudo dnf remove logflux-agent
sudo rm /etc/yum.repos.d/logflux.repo

Homebrew

1
2
brew services stop logflux-agent
brew uninstall logflux-agent