Dashboard GitHub

System Requirements

Hardware and software requirements for LogFlux components

LogFlux Agent

Minimum Requirements

  • CPU: 1 vCPU / 1 core
  • RAM: 512 MB (1 GB recommended)
  • Storage: 200 MB free space (500 MB recommended for logs and buffers)
  • Network: Outbound HTTPS (443) access to LogFlux platform
  • OS: Linux, macOS, or Windows with systemd/service management
  • CPU: 2+ vCPUs for high-volume log processing
  • RAM: 2 GB or more for large-scale deployments
  • Storage: 2 GB free space for log buffering and rotation
  • Network: Broadband connection (1+ Mbps sustained)

Operating System Support

  • Linux: Any distribution with systemd (Ubuntu 18.04+, CentOS 7+, Debian 9+, RHEL 7+)
  • macOS: 10.14 (Mojave) or later
  • Windows: Windows Server 2016+ or Windows 10 version 1809+

LogFlux Inspector CLI

Minimum Requirements

  • CPU: Any 64-bit processor (x86_64, ARM64)
  • RAM: 256 MB
  • Storage: 50 MB free space
  • Network: Internet connection for authentication and log retrieval
  • OS: Linux, macOS, or Windows
  • RAM: 512 MB or more for large result sets
  • Storage: 500 MB for local caching and exports
  • Network: Broadband connection for optimal performance

Operating System Support

  • Linux: Any distribution with glibc 2.17+ (most 2014+ distributions)
  • macOS: 10.14 (Mojave) or later (Intel and Apple Silicon)
  • Windows: Windows 10 version 1809 or later (64-bit)

LogFlux Inspector GUI

Minimum Requirements

  • CPU: Dual-core 64-bit processor
  • RAM: 4 GB (8 GB recommended)
  • Storage: 500 MB free space
  • Display: 1280x720 resolution
  • Network: Internet connection for authentication and log retrieval
  • Graphics: Hardware-accelerated graphics support recommended
  • CPU: Quad-core processor or better
  • RAM: 8 GB or more
  • Storage: 2 GB free space for caching and exports
  • Display: 1920x1080 or higher resolution
  • Network: Broadband internet connection

Operating System Support

  • Linux: Modern distributions with GTK 3.20+ or Qt 5.12+
  • macOS: 10.14 (Mojave) or later (Universal binary for Intel & Apple Silicon)
  • Windows: Windows 10 version 1809 or later (64-bit)

LogFlux SDKs

Go SDK

  • Go Version: 1.19 or later
  • Platform: Any Go-supported platform (Linux, macOS, Windows, BSD)
  • Dependencies: Standard library only (no external dependencies)
  • Memory: Minimal overhead (~1-5 MB depending on buffer size)

JavaScript SDK

  • Node.js: 16.0 or later (for server-side usage)
  • Browser: Modern browsers (Chrome 80+, Firefox 74+, Safari 13+, Edge 80+)
  • Dependencies: None (zero external dependencies)
  • Memory: Minimal overhead (~1-3 MB)

Python SDK

  • Python Version: 3.8 or later
  • Platform: Any Python-supported platform
  • Dependencies: Standard library only (no external dependencies)
  • Memory: Minimal overhead (~2-5 MB depending on buffer size)

Java SDK

  • Java Version: Java 11 or later (LTS versions recommended)
  • Platform: Any JVM-supported platform
  • Dependencies: Minimal dependencies (JSON processing only)
  • Memory: ~5-10 MB heap overhead (configurable)

Network Requirements

Outbound Connectivity

All LogFlux components require outbound HTTPS access to:

  • LogFlux Platform: *.logflux.io (443/HTTPS)
  • Authentication: API authentication endpoints
  • Log Transmission: Encrypted log data upload

Firewall Configuration

  • Outbound HTTPS (443): Required for all components
  • Local Sockets: Agent uses Unix sockets for local communication
  • No Inbound Ports: LogFlux components don’t require inbound connectivity

Proxy Support

  • HTTP/HTTPS Proxy: Supported via standard environment variables
  • Authentication: Basic and NTLM proxy authentication supported
  • Corporate Networks: Compatible with corporate proxy configurations

Security Requirements

Encryption Support

  • TLS 1.2+: Required for all network communications
  • RSA 2048+: Minimum key size for client-side encryption
  • AES-256-GCM: Used for local log encryption

File System Permissions

  • Agent Configuration: Read access to /etc/logflux-agent/
  • Private Keys: Secure storage with 600 permissions recommended
  • Log Files: Read access to monitored log files
  • Temporary Storage: Write access for buffering and caching

Performance Considerations

High-Volume Environments

  • CPU: Scale CPU cores with log volume (1 core per 10k logs/sec)
  • RAM: Increase buffer sizes for burst handling
  • Storage: Fast SSD recommended for high-throughput scenarios
  • Network: Ensure sufficient bandwidth for peak log rates

Resource Limits

  • Memory Usage: Configurable buffer sizes to control memory consumption
  • CPU Usage: Rate limiting and batching to control CPU load
  • Disk Usage: Automatic cleanup and rotation for temporary files
  • Network Usage: Compression and batching to optimize bandwidth

Compatibility Matrix

Container Platforms

  • Docker: All components available as Docker images
  • Kubernetes: Helm charts and YAML manifests provided
  • Podman: Compatible with Podman container runtime
  • containerd: Direct containerd support via CRI

Cloud Platforms

  • AWS: AMIs and marketplace listings available
  • Google Cloud: GCE images and Cloud Marketplace
  • Azure: VM images and marketplace offerings
  • Digital Ocean: Droplet images and one-click apps

Architecture Support

  • x86_64 (amd64): Fully supported on all platforms
  • ARM64 (aarch64): Supported on Linux and macOS (Apple Silicon)
  • ARM (32-bit): Limited support (Agent only, Linux)

Verification Commands

Check System Resources

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# Check available memory
free -h

# Check available disk space
df -h

# Check CPU information
lscpu

# Check OS version
cat /etc/os-release

Test Network Connectivity

1
2
3
4
5
6
7
8

# Test HTTPS connectivity to LogFlux
curl -I https://api.logflux.io/health

# Test DNS resolution
nslookup api.logflux.io

# Check proxy configuration
echo $https_proxy

Verify Requirements

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# For Go development
go version

# For Node.js development
node --version
npm --version

# For Python development
python3 --version
pip3 --version

# For Java development
java -version
javac -version

Support and Troubleshooting

If your system doesn’t meet the minimum requirements or you encounter issues:

  1. Check Requirements: Verify all minimum requirements are met
  2. Update Systems: Ensure OS and runtime versions are current
  3. Resource Monitoring: Monitor CPU, memory, and disk usage during operation
  4. Network Testing: Verify connectivity to LogFlux endpoints
  5. Contact Support: Reach out through the LogFlux dashboard for assistance