Download the PHP package mahmoud-mhamed/laravel-logman without Composer

Logman

Error reporting & log management for Laravel — automatic exception notifications with a powerful built-in log viewer, mute/throttle controls, and an analysis dashboard.

What it does

When an unhandled exception occurs in your Laravel app, Logman captures everything — the stack trace, the request, the authenticated user, recent database queries, queue job details — and sends a rich, formatted notification to your configured channel. All of this happens automatically, with zero code changes.

On top of that, Logman ships with a full-featured log viewer you can access from your browser to browse, search, filter, mute, throttle, and review your Laravel log files.

Features

Notifications

• Multi-Channel — send to Slack, Telegram, Discord, Email — or all at once
• Automatic Exception Reporting — every unhandled exception, reported with full context
• Rich Error Details — stack trace, request info, auth user, DB queries, job context, environment
• Custom Channels — register your own notification driver with one line
• Queue Support — send notifications asynchronously via Laravel queues
• Retry Logic — configurable retry attempts per channel on failure
• Log Level per Channel — each channel can filter by minimum severity (e.g. Mail = critical only)
• Per-Channel Throttle — independent cooldown per channel per exception
• Rate Limiting — prevents the same exception from flooding your channels (global cooldown)
• Mute System — temporarily silence specific exceptions
• Throttle System — limit how many times an exception is reported per time period

Log Viewer (/logman)

• Browse & Search — full-text search with multi-word AND matching + regex mode
• Level Filtering — emergency, alert, critical, error, warning, notice, info, debug
• Date & Time Filtering — filter by date range and time range
• Analysis Dashboard — charts, statistics, per-file breakdowns, today's summary
• Review System — mark entries as reviewed / in-progress / won't-fix with notes
• Mute & Throttle from UI — mute or throttle any error directly from the log viewer
• Stack Trace Viewer — expandable details with tabs (Stack Trace, Context, Raw)
• In-Detail Search — search within stack traces with match navigation (prev/next)
• File Management — download, clear, delete, batch-delete log files
• Grouped Errors — deduplicated view of recurring errors with counts
• Export — download filtered logs as CSV or JSON
• Bookmarks — save log entries for later reference
• Config Viewer — view all package settings from the web UI
• About Page — quick overview of features, channels, commands
• Dark Mode — full dark/light theme with localStorage persistence
• Zero Dependencies — no external CSS/JS frameworks, pure standalone UI
• Responsive — works on desktop and mobile

Request Logging

• Log every incoming HTTP request — disabled by default; flip one switch to capture all requests
• Log on demand — call logman_log_request() (or Logman::logRequest()) anywhere to record a single request
• Dedicated log file — written to logman-requests-*.log and browsable in the Log Viewer automatically
• Configurable payload — include/exclude query, body, headers, and response status
• Filter from .env — restrict by HTTP method, by URL path pattern, or by a substring in the URL
• Path exclusions — skip assets, health checks, and third-party routes (Logman's own routes are always excluded)
• Secret-safe — bodies, query params, and headers are masked using the same hidden_fields as notifications

Requirements

• PHP 8.1+
• Laravel 10.x, 11.x, or 12.x

Installation

Laravel auto-discovers the package. Then run the install command:

This will:

• Publish the config file (config/logman.php)
• Create the storage directory (storage/logman) with .gitignore
• Add all required env variables to .env and .env.example

Use --force to overwrite an existing config file with the latest version.

Updating config after a package update

When Logman adds new config options in a new version, you can add them automatically:

This will compare your config/logman.php with the package default and insert any missing keys — with their default values, comments, and original formatting preserved. Your existing values stay untouched.

Quick Start

1. Pick a channel and configure it (see details below)

2. Test your setup

3. Open the Log Viewer

Navigate to /logman in your browser.

Configuration

Publish the config file:

To overwrite an existing config with the latest defaults:

To add missing config keys after a package update (preserves your existing values):

Publish the views (optional):

General Options

Channel: Slack

Slack is enabled by default.

Setup:

1. Go to https://api.slack.com/apps
2. Click Create New App > From scratch
3. Give it a name (e.g. "Exception Bot") and select your workspace
4. In the left sidebar, click Incoming Webhooks
5. Toggle Activate Incoming Webhooks to On
6. Click Add New Webhook to Workspace
7. Select the channel and click Allow
8. Copy the Webhook URL

Add to .env:

If your app doesn't already define a slack logging channel, Logman creates one automatically using slack_channel_config in the config file.

Channel: Telegram

Setup:

1. Open Telegram and search for @BotFather
2. Send /newbot and follow the prompts to create a bot
3. Copy the Bot Token you receive
4. Add the bot to your group/channel
5. To get the Chat ID: send a message in the group, then open https://api.telegram.org/bot<TOKEN>/getUpdates and find the chat.id value

Add to .env:

Enable in config/logman.php:

Channel: Discord

Setup:

1. Open your Discord server and go to Server Settings > Integrations
2. Click Webhooks > New Webhook
3. Choose a name and the channel to post to
4. Click Copy Webhook URL

Add to .env:

Enable in config/logman.php:

Channel: Mail

Sends exception reports via email using Laravel's built-in mail system. Make sure your app's mail config (config/mail.php) is working first.

Add to .env:

Enable in config/logman.php:

Multiple recipients: use comma-separated emails in LOGMAN_MAIL_TO.

Per-Channel Options

Every channel supports these options:

Available log levels (from lowest to highest severity):

Setting min_level to error means only error, critical, alert, and emergency will be reported to that channel. Setting it to debug reports everything.

Example — Slack gets everything sync, Mail only gets critical errors async:

Rate Limiting & Throttling

Logman uses two levels of protection to prevent notification flooding:

Level 1: Global Rate Limit

Runs first, before any channel is contacted. If the same exception (same class + file + line) fires again within the cooldown window, it is blocked for all channels at once. This is the fast, cheap check that prevents unnecessary work.

When an error is re-sent after being rate-limited, the notification includes:

This error was suppressed 5 time(s) since last report (rate limited).

Level 2: Per-Channel Throttle

Runs second, independently for each channel. This lets you set different cooldowns per channel — for example, send to Slack every second but limit emails to once per minute.

How They Work Together

Both checks are lightweight (file read / cache lookup) and much faster than the actual HTTP request or email send they prevent. Keeping both levels gives you coarse global protection plus fine-grained per-channel control.

Log Viewer Options

Request Logging

Log every incoming HTTP request to a dedicated log file that shows up in the Log Viewer. Disabled by default — enable it with the config flag or LOGMAN_REQUEST_LOGGING=true.

Logman's own viewer routes are always excluded, so request logging never logs itself.

Filter which requests get logged, entirely from .env:

only and only_containing are allowlists: when either is set, a request is logged only if it matches at least one entry (the two are combined with OR). Leave both empty to log every request.

Log a request on demand

Want to log a single request from your own code — regardless of the config switches? Call the helper (or the facade) anywhere: it writes to the same logman_requests channel and bypasses the enabled flag and all skip/allowlist filters.

Each manual entry records the file and line it was called from (called_from), shown as a banner at the top of the log's detail view.

Open in your IDE: set LOGMAN_EDITOR and that called_from location becomes a clickable link that jumps straight to the source.

Viewing logs written on a server? Map the remote path to your local checkout in config/logman.php:

Pages

Usage

Automatic (default)

With auto_report_exceptions enabled (default), every unhandled exception is reported automatically. No code changes needed.

Manual Reporting

Ignoring Exceptions

Uses instanceof — ignoring a parent class also ignores all its subclasses.

Mute System

Temporarily silence specific exceptions from being reported. Available from the log viewer UI or the Mutes page.

• Exception Class — fully qualified class name or partial match
• Message Pattern — optional partial message match
• Duration — 1h, 6h, 12h, 1d, 3d, 1w, 1m
• Reason — optional note for context
• Hit Counter — tracks how many times the mute blocked a notification
• Extend — extend active mutes without removing them

Throttle System

Limit how many times an exception is reported per time period.

Example: allow max 5 reports per hour for a specific exception — after that, further occurrences are silently suppressed until the period resets.

What Gets Reported

Each notification includes:

Performance

Logman has zero impact on normal requests (no exceptions). When an exception occurs:

• In-memory caching — JSON data files are read at most once per request
• Deferred writes — state changes are batched and written once at request termination
• Singleton services — instantiated once per application lifecycle
• Early returns — empty checks skip all processing

Security

For production, add authentication middleware and/or an authorize callback:

Custom Channels

Register your own notification channel:

Register it in a service provider:

Then add it to your config:

Artisan Commands

Daily Digest

Logman can send a daily summary of all log activity to your enabled channels (Slack, Telegram, Discord, Mail). The digest includes:

• Total entries and error count
• Breakdown by log level (emergency, error, warning, info, etc.)
• Top 5 most frequent errors
• Per-file entry counts

Automatic Setup (Recommended)

Enable the daily digest in your config/logman.php — no manual scheduler setup needed:

Logman will automatically register the scheduled command for you.

Per-Channel Control

Each channel has its own daily_digest flag. A channel can receive real-time exception reports but skip the digest, or vice versa:

Manual Setup (Alternative)

If you prefer manual control, you can skip the config flag and schedule it yourself in routes/console.php or app/Console/Kernel.php:

Options

Testing

Tests cover:

• MuteService (mute, unmute, throttle, rate limiting)
• LogmanService (exception reporting, custom drivers, ignored exceptions)
• All routes (index, dashboard, mutes, throttles, grouped, bookmarks, config, about)

License

MIT