Dashboard

System Requirements

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)

Grafana Datasource Plugin & API Server

Requirements

  • Grafana: 9.0 or later
  • LogFlux API Server: Runs locally on port 8383
  • RAM: 2 GB minimum (4 GB recommended for large datasets with DuckDB)
  • Storage: 500 MB free space for DuckDB and caching
  • CGO: Required for the API Server and Grafana plugin backend (DuckDB dependency)
  • Go: 1.21 or later (for building from source)
  • Node.js: 16+ (for building Grafana plugin frontend)

Operating System Support

  • macOS: Intel and Apple Silicon (darwin-amd64, darwin-arm64)
  • Linux: x86_64 (linux-amd64) and ARM64 (linux-arm64)
  • Windows: x86_64 (windows-amd64)

LogFlux SDKs

Go SDK

  • Go Version: 1.23 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 queue size)

Swift SDK

  • Swift Version: 5.9 or later
  • Platform: macOS 13+, iOS 16+, tvOS 16+, watchOS 9+
  • Dependencies: None (Apple frameworks only: CryptoKit, Security, Foundation, Network)
  • Memory: Minimal overhead (~2-5 MB depending on queue size)
  • Storage: Disk queue in ~/Library/Caches/ (auto-eviction)

JavaScript SDK

  • Node.js: 18.0 or later
  • Dependencies: None (zero runtime dependencies, Node built-ins only)
  • Memory: Minimal overhead (~1-5 MB depending on queue size)

Python SDK

  • Python Version: 3.10 or later
  • Platform: Any Python-supported platform
  • Dependencies: cryptography>=41.0 (for AES-256-GCM)
  • Memory: Minimal overhead (~2-5 MB depending on queue size)

Java SDK

  • Java Version: 11 or later (LTS recommended: 11, 17, 21)
  • Platform: Any JVM-supported platform
  • Dependencies: None (javax.crypto, java.net.http, java.util.zip)
  • Memory: Minimal overhead (~5-10 MB depending on queue size)

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 4096: 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.ingest.eu.logflux.io/health

# Test DNS resolution
nslookup api.ingest.eu.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