Eloquentize logo
Eloquentize

Getting started

Eloquentize offers a comprehensive monitoring solution for Laravel applications by providing a simple library integration, seamless API usage, and a customizable dashboard to visualize daily projects metrics. It enables efficient tracking and aggregation of model event metrics without additional coding, enhancing project management and insight.

Requirements

At this point you need a laravel project, even if his version his very old ( 5.6 with php 7.4 is ok, mmm not really ok, because you might not use that anymore, but eloquentize will works on that. )

Having access to the shell might be a good thing to have, but it’s not mandatory, thanks to laravel scheduler. So you need to have a cron job activated on your server, if you use Laravel Forge just activate Laravel scheduler option.

You need table with timestamps, this is the point.

Installation

The eloquentize library will be available soon on composer, as soon as the library will be available i assume you can do a composer require eloquentize/client

To set up Eloquentize, start by installing it through Composer with the following command:

composer require eloquentize/laravel-eloquentize-client

This should be done as soon as it becomes available. After installation, proceed to app.eloquentize.com to create your account and generate an API key. This key should then be added to your .env file in the following manner to complete the configuration process:

ELOQUENTIZE_API_TOKEN=your_api_key_here

Metrics collect

Eloquentize simplifies the integration into your Laravel projects by connecting through a library, utilizing an API for operations, and providing a dashboard for metrics visualization. This enables tracking of model events such as creation, update, and deletion efficiently without additional coding.

php artisan eloquentize:models-count --dry

You must define the list of commands to use for your project, among all the commands offered by Eloquentize

You can tailor the data collection to your needs by specifying dates, event types, or selecting specific models, with aggregation commands available for deeper insights. These commands can be automated by scheduling them within App\Console\Kernel.

For those with existing projects, historical data analysis from the project's inception is facilitated through:

php artisan eloquentize:models-count-legacy

This command allows for comprehensive data review and analysis without the need for altering current project setups.

About the author

© Eloquentize 2024