Get Started with LogFlux in 5 Minutes

1. Get an API Key

Sign in to dashboard.logflux.io and go to Settings > API Keys. Create a new key – it will look like eu-lf_abc123....

2. Install the Agent

Quick install (Linux/macOS):

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

Other methods:

MethodCommand
APT (Debian/Ubuntu)curl -fsSL https://download.logflux.io/apt/install.sh | sudo bash
Homebrew (macOS)brew install logflux-io/tap/logflux-agent
Dockerdocker run -d -e LOGFLUX_API_KEY=eu-lf_... logflux/logflux-agent:latest

See Agent Installation for all options including RPM and Kubernetes.

3. Configure

Set your API key in the agent config:

1
sudo nano /etc/logflux-agent/agent.yaml
1
api_key: eu-lf_your_api_key_here

That’s the only required field. Start the agent:

1
sudo systemctl enable --now logflux-agent

4. Send Your First Log

1
logflux -message "Hello from LogFlux!"

With severity levels:

1
2
3
logflux -message "Application started" -level info
logflux -message "Connection slow" -level warn
logflux -message "Request failed" -level error

5. Verify

1
2
logflux -health     # Check agent status
logflux -version    # Check version

Your logs are now encrypted client-side (AES-256-GCM) and flowing to LogFlux. Encryption keys are negotiated automatically during the handshake – no manual key setup required. See Security & Encryption for the full protocol.

Use an SDK Instead

Send logs directly from your application code – no agent needed:

LanguageInstallLink
Gogo get github.com/logflux-io/logflux-go-sdk/v3Go SDK
JavaScriptnpm install @logflux-io/logflux-js-sdkJS SDK
Pythonpip install logflux-sdkPython SDK
JavaMaven/Gradle (io.logflux:logflux-sdk)Java SDK
SwiftSwift Package ManagerSwift SDK

All SDKs handle encryption and key negotiation automatically. Initialize with your API key and start logging:

1
2
3
4
5
6
7
8
9
// Go example
logflux.Init(logflux.Options{
    APIKey: "eu-lf_your_api_key_here",
    Node:   "my-service",
})
defer logflux.Close()

logflux.Info("Application started")
logflux.Error("Something broke", logflux.WithStack())

Next Steps