Sign inSign up

samuelmatildes/sosparser

By samuelmatildes

•Updated 5 months ago

SOSParser is a tool to Parse and Analyze Linux sosreport and supportconfig files into HTML

Image
0

6.7K

samuelmatildes/sosparser repository overview

⁠SOSParser

Automated web-based analyzer for Linux diagnostic reports (sosreport & supportconfig)

GitHub Telegram

Transform complex Linux diagnostic tarballs into beautiful, interactive HTML reports with a single click. No manual log parsing, no command-line expertise required.


⁠🚀 Quick Start

docker run -d -p 8000:8000 --name sosparser samuelmatildes/sosparser:latest

Then open http://localhost:8000⁠ in your browser, upload your sosreport/supportconfig tarball, and get instant insights.


⁠✨ Key Features

⁠📊 Comprehensive System Analysis
  • Hardware & System Info: CPU, memory, disks, virtualization detection
  • Network Analysis: Interfaces, routing, DNS, firewall rules, connectivity tests
  • Filesystem Analysis: Mounts, LVM, disk usage, filesystem types
  • Log Analysis: System logs, kernel logs, auth logs, journalctl support
  • Process Information: Process tree, utilization, I/O, handlers (lsof)
  • SAR Metrics: Interactive time-series charts for 18+ performance metrics
  • Cloud Detection: AWS, Azure, GCP, Oracle Cloud metadata analysis
  • Security: SELinux, AppArmor, firewall, failed logins, package verification
⁠🎯 Multi-Platform Support
  • ✅ Red Hat/CentOS/RHEL sosreports (sos 3.x, 4.x)
  • ✅ SUSE/openSUSE supportconfig archives
  • ✅ Debian/Ubuntu sosreports with journalctl support
  • ✅ Fedora, Rocky Linux, AlmaLinux and other distributions
⁠🔒 Public Mode for Demo/SaaS Deployments
docker run -d -p 8000:8000 -e PUBLIC_MODE=true samuelmatildes/sosparser:latest
  • Zero data retention: Reports are deleted immediately after viewing
  • Audit logging: Comprehensive JSON logs for security monitoring
  • Privacy-focused: Ideal for public demos or multi-tenant environments
⁠💾 Private Mode with Persistent Storage
docker run -d -p 8000:8000 \
  -v $(pwd)/uploads:/app/webapp/uploads \
  -v $(pwd)/outputs:/app/webapp/outputs \
  samuelmatildes/sosparser:latest
  • Report library: Browse and manage previously generated reports
  • Persistent storage: Keep reports across container restarts
  • Local analysis: Perfect for on-premise deployments

⁠📦 Available Tags

  • latest - Latest stable release (currently 0.2.23)
  • v0.2.23, v0.2.22, etc. - Specific version releases
  • Multi-platform: linux/amd64, linux/arm64

⁠🔧 Configuration Options

⁠Log Line Limits

Control how many log lines are extracted for better performance:

docker run -d -p 8000:8000 \
  -e LOG_LINES_PRIMARY=2000 \
  -e LOG_LINES_SECONDARY=1000 \
  samuelmatildes/sosparser:latest
VariableDefaultDescription
LOG_LINES_PRIMARY1000Primary logs (messages, syslog, dmesg, journal)
LOG_LINES_SECONDARY500Secondary logs (boot, cron, mail, audit)
⁠Environment Variables
VariableDefaultDescription
PUBLIC_MODEfalseEnable public mode (auto-delete reports)
LOG_LINES_PRIMARY1000Lines for primary logs
LOG_LINES_SECONDARY500Lines for secondary logs

⁠📖 What Gets Analyzed?

SOSParser processes 350+ data points from diagnostic archives:

  • System: Hardware info, kernel, OS, uptime, packages
  • Storage: LVM volumes, mount points, disk usage, RAID
  • Network: Interfaces, routing, DNS, bonds, bridges, VLANs
  • Services: systemd units, cron jobs, enabled services
  • Security: Firewall rules, SELinux/AppArmor, SSH config, sudo config
  • Performance: SAR data with interactive charts (CPU, memory, I/O, network)
  • Processes: Process tree, top processes, I/O stats, open file handlers
  • Logs: System logs, kernel logs, auth logs, service logs, journalctl
  • Cloud: AWS/Azure/GCP/OCI metadata and configurations

⁠🎨 Interactive Features

  • Tabbed interface with subtabs for organized data presentation
  • Interactive SAR charts with Chart.js (CPU, memory, I/O, network metrics)
  • Collapsible sections for efficient navigation
  • Search & filter across logs and configurations
  • Syntax highlighting for config files
  • Responsive design works on desktop, tablet, and mobile

⁠🐳 Docker Compose Example

version: '3.8'
services:
  sosparser:
    image: samuelmatildes/sosparser:latest
    container_name: sosparser
    ports:
      - "8000:8000"
    volumes:
      - ./uploads:/app/webapp/uploads
      - ./outputs:/app/webapp/outputs
    environment:
      - LOG_LINES_PRIMARY=2000
    restart: unless-stopped

Save as docker-compose.yml and run:

docker-compose up -d

⁠🌐 Use Cases

  • IT Support Teams: Quickly diagnose customer systems from sosreports
  • System Administrators: Analyze server health without manual log parsing
  • Cloud Engineers: Understand instance configurations and performance
  • DevOps Teams: Debug production issues from diagnostic archives
  • Training & Demos: Public mode for demonstrations and workshops
  • Compliance Audits: Review security configurations and access logs


⁠📋 Recent Updates (v0.2.23)

⁠New in Latest Version
  • ✅ Journalctl support for Debian/Ubuntu systems without traditional logs
  • ✅ Boot history tracking with journalctl --list-boots integration
  • ✅ Enhanced log parsing with automatic fallback mechanisms
  • ✅ Improved multi-distro compatibility

See full changelog⁠ for details.


⁠🤝 Contributing

We welcome contributions! See our Contributing Guide⁠ for details.


⁠📄 License

MIT License - See LICENSE⁠ for details.


Need help? Join our Telegram community⁠ or open an issue⁠.

Tag summary

Content type

Image

Digest

sha256:bffd31344…

Size

52 MB

Last updated

5 months ago

docker pull samuelmatildes/sosparser