Dashboard GitHub

GUI Inspector

Graphical interface for intuitive log analysis and investigation

LogFlux Inspector GUI is a powerful desktop application that provides an intuitive graphical interface for analyzing, searching, and investigating your encrypted logs. It combines the full power of LogFlux Inspector with an easy-to-use visual interface.

Overview

LogFlux Inspector GUI offers comprehensive log analysis capabilities through a modern desktop interface:

  • Visual Log Browser: Interactive log viewer with syntax highlighting and filtering
  • Advanced Search Interface: Visual query builder with real-time results
  • Real-time Dashboard: Live log monitoring with customizable widgets
  • Export Wizard: Guided export process with format preview
  • Visual Analytics: Charts, graphs, and statistical visualizations
  • Multi-tab Interface: Work with multiple searches and views simultaneously

Key Features

Visual Log Analysis

  • Syntax Highlighting: Color-coded log levels and message components
  • Interactive Filtering: Point-and-click filters for levels, nodes, and time ranges
  • Search Highlighting: Visual highlighting of search terms in results
  • Contextual Details: Expandable log entries with full metadata

Advanced Search Interface

  • Query Builder: Visual interface for constructing complex search queries
  • Time Range Picker: Interactive calendar and time selection
  • Filter Panels: Dedicated panels for log levels, nodes, and custom fields
  • Saved Searches: Save and organize frequently used search patterns

Real-time Monitoring

  • Live Stream View: Real-time log streaming with auto-scroll
  • Alert System: Visual and audio notifications for critical events
  • Dashboard Widgets: Customizable widgets for metrics and summaries
  • Performance Monitoring: Real-time statistics and connection status

Data Export and Analysis

  • Export Wizard: Step-by-step export process with preview
  • Format Selection: Visual format picker with sample output
  • Field Selection: Interactive field chooser for custom exports
  • Batch Operations: Queue multiple export jobs

Installation

For complete installation instructions, see the Installation Guide.

Quick Start

  1. Download LogFlux Inspector GUI from the LogFlux dashboard
  2. Run the platform-specific installer (DMG, MSI, or AppImage/package)
  3. Launch the application from your applications menu
  4. Complete the setup wizard for authentication and encryption

Getting Started

First Launch

  1. Launch Application: Open LogFlux Inspector GUI from your applications menu
  2. Welcome Screen: You’ll see the welcome screen with setup options
  3. Authentication Setup: Configure your LogFlux credentials
  4. Encryption Setup: Set up your private key for log decryption

Authentication Setup

For complete authentication setup, see the Authentication Guide.

Quick GUI Setup

  1. Click Settings → Authentication
  2. Select Personal Access Token and enter your token (starts with lf_pat_)
  3. Go to Settings → Encryption
  4. Browse to your private key file or paste the key content
  5. Click Test Key to verify setup
  6. Click Save

The application will securely store your encrypted credentials locally.

User Interface Overview

Main Interface Components

  • File: Import/export configurations, quit application
  • View: Toggle panels, zoom controls, theme selection
  • Search: Search shortcuts and saved searches
  • Tools: Preferences, key management, diagnostics
  • Help: Documentation, about, update check

Toolbar

  • Connection Status: Shows authentication and connection state
  • Search Box: Quick search with auto-complete
  • Time Range: Quick time range selection
  • Log Level Filters: Toggle buttons for each log level
  • Refresh: Manual refresh and auto-refresh toggle

Side Panels

Search Panel
  • Query Builder: Visual search construction
  • Filters: Node, level, and custom field filters
  • Time Range: Interactive date/time picker
  • Saved Searches: Quick access to saved queries
Statistics Panel
  • Log Level Distribution: Pie chart of log levels
  • Timeline: Histogram of log activity over time
  • Top Nodes: Most active logging nodes
  • Error Trends: Error rate trends and patterns

Main Content Area

Log View
  • Table View: Tabular display with sortable columns
  • Card View: Card-based layout with expandable details
  • Raw View: Plain text view of log messages
  • JSON View: Structured view of log metadata
Stream View
  • Live Logs: Real-time log streaming
  • Auto-scroll: Automatic scrolling to newest logs
  • Pause/Resume: Control stream flow
  • Filters: Real-time filtering of stream

Core Functionality

Searching Logs

  1. Enter search terms in the top search box
  2. Select time range from dropdown
  3. Choose log levels using filter buttons
  4. Click Search or press Enter
  1. Open Search Panel (View → Search Panel)
  2. Use Query Builder for complex queries:
    • Field Selection: Choose fields to search in
    • Operators: Contains, equals, regex, etc.
    • Conditions: AND, OR, NOT logic
    • Grouping: Parentheses for complex logic
  3. Set Time Range with visual picker
  4. Add Node Filters by selecting from list
  5. Click Search to execute

Search Results

  • Pagination: Navigate through large result sets
  • Sorting: Click column headers to sort
  • Export: Export current results to file
  • Details: Click logs to see expanded view

Real-time Monitoring

Stream Setup

  1. Go to View → Stream View
  2. Configure filters in Stream Panel:
    • Log Levels: Select levels to monitor
    • Nodes: Choose specific nodes
    • Keywords: Filter by message content
  3. Click Start Stream

Stream Features

  • Live Updates: Logs appear in real-time
  • Sound Alerts: Audio notifications for errors
  • Highlighting: Search terms highlighted in results
  • Statistics: Live counters and metrics
  • Recording: Save stream to file

Data Export

Export Wizard

  1. Select logs to export (search results or all)
  2. Go to File → Export Logs
  3. Step 1: Choose export format
    • JSON: Structured data export
    • CSV: Spreadsheet-compatible format
    • Plain Text: Human-readable format
    • PDF: Formatted report with charts
  4. Step 2: Select fields to include
  5. Step 3: Configure format options
  6. Step 4: Choose output location
  7. Click Export

Batch Export

  • Queue Jobs: Add multiple export jobs
  • Progress Tracking: Monitor export progress
  • Background Processing: Continue working while exporting
  • Notifications: Alerts when exports complete

Advanced Features

Saved Searches

Creating Saved Searches

  1. Configure your search parameters
  2. Click Save Search button
  3. Enter search name and description
  4. Choose folder/category
  5. Click Save

Managing Saved Searches

  • Organize: Create folders and categories
  • Share: Export search configurations
  • Import: Import shared searches
  • Edit: Modify existing searches

Dashboards

Creating Dashboards

  1. Go to View → Dashboard
  2. Click New Dashboard
  3. Add widgets:
    • Log Level Chart: Pie/bar charts of levels
    • Timeline: Activity over time
    • Statistics: Key metrics and counters
    • Recent Errors: Latest error messages
    • Node Status: Per-node statistics
  4. Arrange and resize widgets
  5. Save dashboard

Dashboard Features

  • Auto-refresh: Configurable refresh intervals
  • Time Ranges: Dashboard-wide time controls
  • Drill-down: Click widgets to view details
  • Full Screen: Presentation mode
  • Share: Export dashboard configurations

Visual Analytics

Chart Types

  • Timeline Charts: Log activity over time
  • Distribution Charts: Log level breakdowns
  • Trend Analysis: Error rates and patterns
  • Geographic Views: Node locations (if configured)
  • Heat Maps: Activity intensity visualization

Interactive Features

  • Zoom: Zoom into time ranges on charts
  • Filter: Click chart elements to filter logs
  • Export: Save charts as images
  • Tooltips: Hover for detailed information

Configuration

Application Settings

General Settings

  • Theme: Light, dark, or system theme
  • Language: Interface language selection
  • Updates: Automatic update checking
  • Performance: Memory and CPU usage limits

Display Settings

  • Font Size: Adjust text size for readability
  • Row Height: Compact or comfortable log rows
  • Syntax Highlighting: Color scheme for logs
  • Time Format: Local or UTC time display

Connection Settings

  • Timeout: Request timeout values
  • Retry: Connection retry attempts
  • Proxy: HTTP/SOCKS proxy configuration
  • SSL: Certificate validation settings

Keyboard Shortcuts

  • Ctrl+F (Cmd+F): Focus search box
  • Ctrl+R (Cmd+R): Refresh current view
  • Ctrl+T (Cmd+T): New search tab
  • Ctrl+W (Cmd+W): Close current tab
  • F5: Start/stop stream

Search and Filtering

  • Ctrl+1-4: Toggle log level filters
  • Ctrl+D: Open date picker
  • Ctrl+S: Save current search
  • Ctrl+E: Export current results

View Controls

  • Ctrl++ (Cmd++): Zoom in
  • Ctrl+- (Cmd+-): Zoom out
  • Ctrl+0 (Cmd+0): Reset zoom
  • F11: Toggle full screen

Troubleshooting

Connection Issues

Authentication Problems

  1. Check Credentials: Verify token in Settings → Authentication
  2. Test Connection: Use “Test Connection” button
  3. Token Expiry: Generate new token if expired
  4. Network: Check firewall and proxy settings

SSL/Certificate Issues

  1. Certificate Validation: Disable if using self-signed certificates
  2. Proxy Settings: Configure if behind corporate proxy
  3. DNS Issues: Verify dashboard URL resolution

Performance Issues

Slow Search Results

  1. Time Range: Narrow down time ranges
  2. Filters: Use more specific filters
  3. Memory: Increase memory limits in settings
  4. Network: Check connection speed

High Memory Usage

  1. Limit Results: Reduce result set sizes
  2. Close Tabs: Close unused search tabs
  3. Clear Cache: Clear application cache
  4. Restart: Restart application periodically

Display Issues

UI Scaling Problems

  1. Display Settings: Adjust system display scaling
  2. Font Size: Modify font size in settings
  3. Theme: Try different theme
  4. Resolution: Check minimum resolution requirements

Missing Features

  1. Version Check: Ensure latest version installed
  2. Permissions: Check application permissions
  3. Dependencies: Verify system dependencies
  4. Reinstall: Clean reinstall if needed

Best Practices

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

GUI-Specific Best Practices

Performance

  • Time Ranges: Always use specific time ranges
  • Result Limits: Limit large result sets
  • Filters: Use filters to reduce data volume
  • Cleanup: Close unused tabs and clear cache

Workflow

  • Saved Searches: Create searches for common patterns
  • Dashboards: Build dashboards for monitoring
  • Exports: Use batch exports for large datasets
  • Organization: Organize searches in folders

System Requirements

For complete system requirements including all LogFlux components, see System Requirements.

GUI-Specific Requirements

  • RAM: 4 GB minimum (8 GB recommended)
  • Display: 1280x720 minimum (1920x1080 recommended)
  • Graphics: Hardware-accelerated graphics recommended
  • OS: macOS 10.14+, Windows 10 1809+, Linux with modern desktop environment

Next Steps