Dashboard GitHub

Getting Started

Quick start guide to get up and running with LogFlux

Welcome to LogFlux! This guide will help you get started with our log management platform in just a few minutes.

What is LogFlux?

LogFlux is a modern, secure log management platform designed for developers and teams who need:

  • Real-time log ingestion with high throughput
  • End-to-end encryption for sensitive data
  • Powerful search and analytics capabilities
  • Developer-friendly APIs and SDKs
  • Cloud-based deployment with global availability

Quick Start

Prerequisites

Step 1: Configure the Agent

Edit the main configuration file:

1

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

Update with your API key:

1
2
3

api_key: your-actual-api-key-here  # Replace with your LogFlux API key
server_url: /tmp/logflux-agent.sock
node: my-first-node

Start the agent service:

1

sudo systemctl enable --now logflux-agent

Step 2: Send Your First Log

Send a simple message using the LogFlux CLI:

1

logflux -message "Hello from LogFlux!"

Step 3: Send Logs with Different Levels

Try different severity levels:

1
2
3
4
5
6
7
8

# Info level (default)
logflux -message "Application started successfully" -level info

# Warning level
logflux -message "Database connection slow" -level warn

# Error level
logflux -message "Failed to process user request" -level error

Step 4: Verify Your Setup

Check that everything is working:

1
2
3
4
5

# Check agent health
logflux -health

# Check version
logflux -version

That’s it! Your logs are now being sent to LogFlux. For advanced features and integrations, continue reading the detailed guides below.

Core Features

  • Log Ingestion: High-performance log collection from any source
  • Search & Query: Real-time search with powerful filtering
  • Security: End-to-end encryption and compliance features
  • Analytics: Built-in dashboards and custom visualizations
  • Scale: Handle millions of logs per second
  • Integrations: Works with Docker, Kubernetes, and more

Need Help?