Log Viewer Laravel Package

Product Decisions This Supports

• Observability & Debugging Roadmap:

  • Replace manual log file parsing with a self-service log exploration tool for developers, reducing MTTR (Mean Time to Resolution) for debugging.
  • Enable proactive monitoring by surfacing critical errors (e.g., error/critical logs) via dashboards or alerts integrated with Log Viewer’s API.
  • Build vs. Buy: Avoid reinventing a log UI (e.g., custom Laravel admin panel) by leveraging this battle-tested package, saving 3–6 months of dev effort.

• Use Cases:

  • Developer Productivity: Replace tail -f storage/logs/laravel.log with a searchable, filterable, and shareable UI (e.g., filter by exception, auth, or payment keywords).
  • Multi-Environment Support: Aggregate logs from staging/production (via API) into a single pane of glass for cross-team debugging.
  • Compliance/Auditing: Export logs for GDPR/SOC2 via the download feature, with filters to isolate PII or sensitive operations.
  • Horizon/Queue Monitoring: Correlate failed jobs in Horizon with their corresponding Laravel logs using sharable links.
  • Onboarding: Provide new hires with a guided tour of critical log patterns (e.g., "Here’s how to debug a 500 error").

• Integration Opportunities:

  • Alerting: Hook Log Viewer’s API into Laravel Notifications or Slack alerts to surface urgent logs (e.g., level=critical).
  • CI/CD: Add a pre-deploy log scan step to flag warnings/errors in staging logs before promotion.
  • Custom Metrics: Use the API to count error occurrences and feed them into a dashboard (e.g., Grafana).

When to Consider This Package

Adopt If:

• Your team spends >2 hours/week manually parsing Laravel logs (e.g., grep, less, or IDE log plugins).
• You need multi-log support (e.g., Horizon, Nginx, Redis) in a single UI without stitching tools.
• Security/compliance requires log retention but needs filtered access (e.g., developers see debug logs, ops see error logs).
• You’re using Laravel 8+ and want a zero-config solution (default path: /log-viewer).
• Your logs are high-volume (package indexes logs for fast search, even with 10K+ entries).

Look Elsewhere If:

• You need real-time streaming (e.g., live tailing logs like tail -f). Solution: Pair with Laravel Echo or a dedicated tool like Laravel Livewire + custom WebSocket.
• Your logs use a proprietary format not supported out-of-the-box. Solution: Extend via custom parsers.
• You require role-based access control (RBAC) for log viewing. Solution: Integrate with Laravel’s gates/policies or build a middleware wrapper.
• Your stack includes non-Laravel services (e.g., Node.js, Python) with unique log formats. Solution: Use ELK Stack or Datadog for multi-language support.
• You need log archival/retention policies (e.g., auto-purge logs older than 30 days). Solution: Combine with a cron job to delete files via the API.

How to Pitch It (Stakeholders)

For Executives (Business Impact):

*"Log Viewer is a 10x productivity boost for our dev/ops teams. Today, debugging issues costs us $X/hour in downtime—this tool cuts that by 70% by replacing manual log parsing with a searchable, filterable UI. For example:

• Reduces MTTR for critical bugs (e.g., payment failures) from 30 mins → 5 mins.
• Enables self-service debugging for junior devs, reducing onboarding time by 2 weeks.
• Supports compliance by letting us export filtered logs for audits without manual work.
• Costs $0 (MIT license) and installs in <1 hour—no new infrastructure needed.

Ask: Should we prioritize this for the next sprint to unlock these savings?"*

For Engineering (Technical Value):

*"Log Viewer solves three key pain points for our Laravel stack:

1. Unified Log Access: No more juggling storage/logs/, Horizon, and Nginx files—one UI for all logs.
2. Supercharged Debugging: Search/filter by keywords, log levels, or timestamps (e.g., find all 'Stripe' errors in the last hour).
3. API-First Design: Build custom integrations (e.g., Slack alerts for critical logs or dashboard metrics) without reinventing the wheel.

Implementation:

• Install: composer require opcodesio/log-viewer + php artisan log-viewer:publish (5 mins).
• Access: /log-viewer endpoint (authenticated via Laravel’s middleware).
• Extend: Custom parsers for proprietary logs or RBAC via middleware.

Trade-offs:

• No real-time streaming (but fast indexed search offsets this).
• Limited RBAC (workaround: wrap routes in can:view-logs gate).

Proposal: Let’s dogfood this in staging for 2 weeks and measure debug time savings. If it reduces P0 incidents by >20%, we should roll it out to production."*

For DevOps/SRE (Reliability Focus):

*"Log Viewer reduces alert fatigue by:

• Surface critical errors first: Filter by level=error or exception to triage issues faster.
• Correlate logs with Horizon jobs: Click a failed job in Horizon → jump to the exact Laravel log entry.
• Mobile-friendly UI: Debug issues on-call from your phone without SSH.

Operational Notes:

• Permissions: Ensure the web server user (e.g., www-data) can read log files (e.g., /var/log/nginx/).
• Performance: Logs are indexed on demand—no upfront processing needed.
• Backup: Use the download feature to archive logs before purging old files.

Ask: Should we restrict access to /log-viewer via IP whitelisting or 2FA for production?"*