taecontrol/larvis

Moonguard assistant package

v1.2.0 2024-02-08 12:44 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• orchestra/testbench: ^7.15
• phpunit/phpunit: ^9.5

MIT

README

Larvis is a PHP package for Laravel that allows a Laravel app to send and report information to MoonGuard or Krater.

Currently, you can use Larvis in the following scenarios:

• To report exceptions from your application to MoonGuard (ideal for production sites that require tracking).
• To report and send messages, exceptions, database queries, and HTTP requests from a Laravel application to Krater (ideal for a development environment where different information needs to be debugged).

What is MoonGuard?

MoonGuard is an open source Filament plugin that aims to provide utilities to monitor your Laravel apps in production.

• MoonGuard helps you track important features like SSL certificates status, uptime, exceptions and server data from your applications.

For more information visit the MoonGuard official site.

What is Krater?

Krater is a desktop application for debugging Laravel apps, it provides an intuitive and friendly interface to debug exceptions, queries, requests and more.

For more information visit the Krater official site.

Installation

You can install Larvis via composer with the following command:

composer require taecontrol/larvis

After installation, we recommend publishing the configuration to customize Larvis' behavior according to your needs.

php artisan vendor:publish --tag larvis-config

Great! Larvis is now installed in your project, and the configuration file should be available at config/larvis.php. At this point, you need to decide how Larvis should operate and behave.

You can configure it to work in Production with MoonGuard and report every exception and server metric from your application once released and deployed to the world, if you want to use Larvis locally to debug your Laravel application, you can set it up to work with Krater. In summary, Larvis can operate in two ways:

• Larvis working with MoonGuard in Production.
• Larvis working Locally with Krater for Debugging.

Important

Larvis default behavior is to work with Krater.

Setup Larvis to work with MoonGuard

To allow Larvis to capture and report exceptions, it is necessary to add three variables on the app .env file:

MOONGUARD_DOMAIN=https://mymoonguard.com
MOONGUARD_SITE_API_TOKEN=LDUxazsuq6aYi9bvSMqc6vkMXOjsD7JdrIN2FkWtA4UVNhaPE02gMS23FIp0
KRATER_DEBUG=false

Variable	Description
MOONGUARD_DOMAIN	The domain where the MoonGuard is located.
MOONGUARD_SITE_API_TOKEN	The app site API Token.
KRATER_DEBUG	Enables or disables Larvis Debug Mode with Krater.

You can obtain the API token at the MoonGuard admin panel (Site administration). This token is unique to your site and is used to authenticate the site in every request to MoonGuard.

No extra steps needed. With this setup Larvis can report your app exceptions to MoonGuard.

Important

Reporting exceptions to MoonGuard only works when the app environment is production.

Setup Larvis to work with Krater

Larvis default behavior is to work and debug with Krater. We have develop several utilities to catch and report data as messages, exceptions, queries and requests easily to Krater.

Watchers

Watchers are components that monitor and record different aspects of your application, such as requests, database queries, and exceptions. Larvis includes the following watchers:

1. QueryWatcher: Detects and reports all queries that are made to the app database.
2. ExceptionWatcher: Detects and reports any exception that have occurred in the app.
3. RequestWatcher: Detects and report any request that have been made to the app.

All the watchers can be enabled or disabled from the Larvis configuration file.

Important

RequestWatcher and QueryWatcher are not compatible with MoonGuard.

Sending Messages to Krater

Larvis understand a message as the data you want to send to Krater, similar to when you use dd($arg) in your projects. In this case, Larvis and Krater use different strategies to format and make the debugging of the data flexible.

There is a global function called larvis($args) that allows you to send any type of data to Krater as a message. Here are some examples of how to use it:

Sending an array of strings

larvis(["hello","i'm Larvis"]);

Sending a string

larvis("Hello");

Sending an array of numbers

larvis([1, 2, 3, 4, 5]);

Sending a null value

larvis(null);

Sending a collection

$collection = collect([1, 2, 3, 4, 5]);
larvis($collection);

Sending an object

$user = new User();
$user->name = 'John Doe';
$user->email = '[e-mail]';
$user->age = 30;
larvis($user);

Watching and Sending Queries to Krater

In order to watch and send queries to Krater the QueryWatcher must be enabled, as we mentioned earlier, this watcher allows you to detect and report all queries that are made to the app database.

QueryWatcher can be enabled in Larvis configuration:

[
    'watchers' => [
        'queries' => [
            'enabled' => true,
        ],
    ],
];

To record isolated queries, you can use the startQueryWatch() and stopQueryWatch() as follow:

larvis()->startQueryWatch();
User::all();
larvis()->stopQueryWatch();

• The startQueryWatch(): starts the QueryWatcher, any query after this line will be recorded and reported.
• The stopQueryWatch(): stops the QueryWatcher, any query after this line will not be logged or reported.

Watching and Sending Exceptions to Krater

In order to watch and send exceptions to Krater the ExceptionWatcher must be enabled, this watcher is enabled by default.

[
    'watchers' => [
        'exceptions' => [
            'enabled' => true,
        ],
    ],
];

Watching and Sending Request to Krater

In order to watch and send request to Krater the RequestWatcher must be enabled, is enables the ability to monitor HTTP requests in your Laravel application and send the relevant information to Krater.

[
    'watchers' => [
        'request' => [
            'enabled' => true,
        ],
    ],
];

Readers

A reader is a utility we have developed to process PHP objects in a practical way. Its versatility allows you to specify the properties that need to be processed from an object, you can modify this in the Larvis configuration.

Currently, this property specification is only compatible with the following Illuminate classes:

• Illuminate\Database\Eloquent\Model
• Illuminate\Support\Collection

In the configuration file, you will find something like:

[
    'readers' => [
        'model' => [
            'props' => [
                'connection',
                'table',
                'primaryKey',
                'keyType',
                'incrementing',
                'with',
                'withCount',
                //...
            ],
        ],
    ],
];

Here you can modify the properties you need to debug an Illuminate model according to your preferences.

You can do the same with an Collection from Illuminate:

[
    'collection' => [
        'props' => [
            'items',
            'escapeWhenCastingToString',
        ],
    ],
];

Commands

Larvis allows you to execute commands for different purposes.

CheckHardwareHealthCommand

This command is useful to obtain the CPU load, RAM memory usage and disk usage (disk consumption and total disk capacity) from the server where your application is running and then be sent to MoonGuard Filament Plugin through HTTP protocol. This command is intended to be used with the Laravel Console Scheduler, register it in your console/Kernel.php file:

Note

We recommend a frequency of 5 minutes or less

protected function schedule(Schedule $schedule): void
{
    $schedule->command(CheckHardwareHealthCommand::class)
        ->everyFiveMinutes();
}

Krater: Debugging Evolved

Krater is a lightweight, cross-platform application that revolutionizes Laravel app debugging on your next major project.

MoonGuard: The Software Creator's Journey [Book]

The MoonGuard development team has written a book named "MoonGuard: The Software Creator's Journey." In this book, we document and explain the entire process of creating, developing, publishing MoonGuard as a Filament Plugin. Every hard corner and special tricks were registered on this book, you can obtain your own digital copy here.

Contributing

Thanks for consider contributing to Larvis, The contribution guide can be found in the MoonGuard documentation.

Credits

• Luis Güette
• Ronald Pereira
• Wilson Velasco
• Alexis Fraudita

License

The Larvis package is open-sourced software licensed under the MIT license.