LogFlux Clients

LogFlux provides powerful client applications for analyzing, searching, and investigating your encrypted logs. Choose the interface that best fits your workflow and preferences.

Available Clients

Key Features

Both LogFlux clients share these core capabilities:

Advanced Log Analysis

• Encrypted Log Access: Decrypt and analyze logs locally for complete privacy
• Complex Search: Advanced filtering with regex, time ranges, and field-specific queries
• Real-time Streaming: Monitor live logs with customizable filters and alerts
• Multi-format Export: Export to JSON, CSV, plain text, and formatted reports

Authentication & Security

• Personal Access Tokens: Secure authentication using PATs from the LogFlux dashboard
• Local Decryption: All log decryption happens locally on your system
• Private Key Management: Secure handling of RSA private keys for encryption
• Zero Trust Architecture: No plaintext logs transmitted over the network

Performance & Scalability

• Efficient Processing: Optimized for handling large volumes of encrypted logs
• Batch Operations: Process multiple operations in parallel
• Caching: Smart caching for improved performance on repeated queries
• Resource Management: Configurable memory and CPU usage limits

Choosing the Right Client

Use LogFlux Inspector CLI When:

• Automation Required: Scripting log analysis tasks
• CI/CD Integration: Incorporating log analysis into pipelines
• Server Environments: Working on headless servers without GUI
• High Performance: Processing very large datasets efficiently
• Scheduling: Running periodic analysis jobs via cron
• Remote Access: Working over SSH connections

Use LogFlux Inspector GUI When:

• Interactive Analysis: Exploring logs visually and interactively
• Dashboard Creation: Building custom monitoring dashboards
• Report Generation: Creating formatted reports with charts
• Team Collaboration: Sharing visual findings with team members
• Ad-hoc Investigation: Investigating incidents and anomalies
• Learning: Getting familiar with LogFlux capabilities

Common Workflows

Security Incident Investigation

1. GUI: Use dashboards to identify anomalies and time ranges
2. GUI: Visual timeline analysis to understand incident scope
3. CLI: Export relevant logs for detailed forensic analysis
4. GUI: Create incident reports with visualizations

DevOps Monitoring

1. CLI: Automated alerting on error patterns via cron jobs
2. GUI: Real-time dashboards for system health monitoring
3. CLI: Scheduled exports for compliance and archival
4. GUI: Interactive troubleshooting during incidents

Compliance & Auditing

1. CLI: Automated compliance report generation
2. GUI: Interactive audit log review and verification
3. CLI: Bulk export of logs for regulatory submissions
4. GUI: Visual verification of access patterns and security events

Installation

For complete installation instructions, see the Installation Guide.

Both clients are available through the LogFlux dashboard after login:

1. Download from https://dashboard.logflux.io
2. Choose CLI or GUI based on your needs
3. Select your platform and architecture
4. Follow platform-specific installation steps

Supported Platforms

• All Platforms: macOS (Intel & Apple Silicon), Linux (x86_64, ARM64), Windows (x86_64)
• CLI: Cross-platform binaries
• GUI: Native installers (DMG, MSI, AppImage, packages)

Authentication Setup

For complete authentication setup, see the Authentication Guide.

Both clients use Personal Access Tokens (PATs) and RSA private keys:

1. Generate a PAT in the LogFlux dashboard
2. Configure authentication in your chosen client
3. Set up your RSA private key for log decryption
4. Verify setup with test commands

Environment variables work for both clients:

1
2

export LOGFLUX_PAT="lf_pat_your_token_here"
export LOGFLUX_PRIVATE_KEY_FILE="~/.logflux/private_key.pem"

Integration Possibilities

CLI Integration

• Shell Scripts: Incorporate into bash/PowerShell scripts
• CI/CD Pipelines: GitHub Actions, Jenkins, GitLab CI
• Monitoring Systems: Nagios, Zabbix, Prometheus alerting
• Cron Jobs: Scheduled analysis and reporting

GUI Integration

• Screen Sharing: Remote desktop and team collaboration
• Report Export: Integration with document management systems
• Dashboard Embedding: Screenshots and exports for presentations
• Training Materials: Interactive demonstrations and walkthroughs

Best Practices

For comprehensive security guidelines, see Security Best Practices. For standard configuration patterns, see Configuration Examples.

Client Usage Best Practices

Performance

• Time Filtering: Always use specific time ranges to limit data volume
• Result Limits: Set appropriate limits for large queries
• Local Caching: Enable caching for frequently accessed data
• Resource Planning: Allocate sufficient CPU and memory for large operations

Workflow

• Complement Usage: Use both CLI and GUI for different aspects of analysis
• Automation Balance: Automate routine tasks, investigate interactively
• Documentation: Document common queries and analysis patterns
• Team Training: Ensure team members are proficient with both tools

Next Steps

• Get Started: Choose your preferred client and follow the installation guide
• Learn the Basics: Start with simple searches and exports
• Explore Advanced Features: Discover automation, dashboards, and analytics
• Integrate Workflows: Incorporate LogFlux clients into your existing processes

Related Documentation

• LogFlux Inspector CLI - Command-line interface documentation
• LogFlux Inspector GUI - Graphical interface documentation
• LogFlux Agent - Set up log collection
• Security Architecture - Understand encryption and privacy