README.md

Lucent-Package

Introduction

The lucent-package is an essential component that connects your applications with the Lucent Web App for seamless error logging. It is crafted to be integrated into the very applications you wish to monitor for errors.

Important: Before incorporating the lucent-package into your app, ensure that you have the Lucent Web App configured and ready to go. If you haven't set up the Lucent Project yet, please follow the link below to get started.

Getting Started with Lucent

To establish a robust error tracking system, your first step is to set up the Lucent Project. Detailed instructions and necessary resources can be found at the following link:

Set Up Lucent Project

Once the Lucent Project is in place, you can proceed to integrate the lucent-package into your application to begin error logging.

Installation

Install Lucent Package

composer require manadinho/lucent

Publish Configurations

php artisan vendor:publish --provider="Manadinho\Lucent\LucentServiceProvider"

Configuration

After creating a new project in your Lucent Project, you will obtain a LUCENT_KEY. Place this key along with the URL of your Lucent Project into the .env file of the Laravel project you wish to track. Your .env file should now include the following entries:

LUCENT_KEY=paste_your_copied_lucent_key_here
LUCENT_URL=https://example.com/lucent

Navigate to the app/Exceptions/Handler.php file in your Laravel project and import the Lucent Facade at the beginning of the file:

use Manadinho\Lucent\Facades\Lucent;

Then, within the register method of your Handler.php file, enhance the reportable method by adding a call to Lucent::register($e). This ensures that any thrown exceptions are captured and logged by the Lucent Web App. Here's the complete method for clarity:

public function register(): void
{
    $this->reportable(function (Throwable $e) {
        Lucent::register($e);
    });
}

Config Options

Modify the settings of the package by editing the config/lucent.php file. Here are the available configuration options:

with_request_details [boolean]

This option allows you to choose whether to log the request details associated with the error.

with_app_details [boolean]

Enable this to log application-specific details, such as PHP version, Laravel version, environment, and locale.

with_user_details [boolean]

You can set it to true if you want to log the logged in user details.

line_count [boolean]

Adjust this setting to define the number of lines from the file you wish to log.