README

A package for sending your logs to a Grafana Loki server. Set it up, schedule a recurring job, and each log will be batched and sent asynchronously as your application runs.

Installation and Setup

1. Install the package by running composer require alexmacarthur/laravel-loki-logging.
2. Publish the configuration file:

php artisan vendor:publish --provider=AlexMacArthur\\LaravelLokiLogging\\L3ServiceProvider

1. Create a new log channel in your config/logging.php file:

   'loki' => [
     'driver' => 'monolog',
     'handler' => \AlexMacArthur\LaravelLokiLogging\L3Logger::class,
   ]

1. Configure at least a LOG_CHANNEL environment variable to use the channel you created in the previous step. See more available environment variables below.

2. Configure the loki:persist job to run at a regular interval. Unless there's reason to do otherwise, every minute is a good start.

Schedule::command('loki:persist')->everyMinute()->withoutOverlapping();

// Or using the class directly...

use AlexMacArthur\LaravelLokiLogging\L3Persister;

Schedule::command(L3Persister::class)->everyMinute()->withoutOverlapping();

1. Log::info('Start logging!');

Environment Variables

By default, the following environment variables are used for logging.

Configuration

The following configuration properties are used when forming and sending logs:

Variable Substitution

All tags and log messages can be enhanced with variable names provided by Monolog:

• message
• context
• level
• level_name
• channel
• datetime
• extra

To use them, wrap them in curly braces:

'format' => 'My log level is: {level_name}, and my message is: {message}',

Authentication

Loki does not provide any authentication out of the box, but it's highly recommended to configure via reverse proxy. This package only supports Basic Auth. If you place your server behind nginx, this can be set up here.

Shout-Out

This package was originally forked from @devcake-deventer's laravel-loki-logging package. Thank you for the great starting point!