Skip to content

LaraGram Watchdog

Introduction

Watchdog is a pre-built package for managing logs and real-time reports.

Watchdog can display logs in real time on your terminal, report to a Telegram chat for you, and also create a panel for you to read logs and manage them in Telegram.

Installation

Watchdog is installed by default with Laragram, however you can easily install it with Composer:

shell
composer require laraxgram/watchdog

Publishing assets

shell
php laragram vendor:publish --tag=watchdog-config

If you use composer dev, the watchdog will also run automatically, but you can run it manually with the following command:

shell
php laragram watchdog

From now on, logs will be reported to you in real time.

Configuration

CLI Log Capture

This feature, when enabled, will display logs in the terminal for you:

php
'cli' => [
   'enabled' => true,
   'levels' => ['*']
],

INFO

Log levels can be any of the following, * meaning all of them.

DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY

Automatic Log Reporting

This feature is more suitable in a production environment. In the event of an error, a bot tweet is sent instantly to the specified chats in Telegram:

php
'report' => [
    'enabled' => false,
    'chats' => [
        // chat_id of the chats to which logs should be reported.
    ],
    'levels' => ['*']
],

INFO

Log levels can be any of the following, * meaning all of them.

DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY

Log Manager Access

This feature sends you an admin panel in Telegram where you can open the created log files, navigate between logs, or even delete them without direct access to the server.

php
'manager' => [
    'enabled' => true,
    'command' => 'log', // Panel send command (default `/log`)
    'admins' => [
        // user_id of users who have permission to access the panel.
    ]
],

Released under the MIT License.