finnish

Author: ExpDev07

README.md

@@ -2,8 +2,6 @@
 # laravel-logsnag
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/expdev07/laravel-logsnag.svg?style=flat-square)](https://packagist.org/packages/expdev07/laravel-logsnag)
-[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/expdev07/laravel-logsnag/run-tests?label=tests)](https://github.com/expdev07/laravel-logsnag/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/expdev07/laravel-logsnag/Check%20&%20fix%20styling?label=code%20style)](https://github.com/expdev07/laravel-logsnag/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/expdev07/laravel-logsnag.svg?style=flat-square)](https://packagist.org/packages/expdev07/laravel-logsnag)
 
 Get a realtime feed of your Laravel project’s most important events using Logsnag. Supports push notifications straight to your 
@@ -48,10 +46,30 @@ return [
     |
     */
 
+    /**
+     * The project name.
+     */
     'project' => env('LOGSNAG_PROJECT', 'laravel'),
 
+    /**
+     * The API token.
+     */
     'token' => env('LOGSNAG_TOKEN', ''),
 
+    /**
+     * A mapping of icons for logging.
+     */
+    'icons' => [
+        'DEBUG'     => 'ℹ️',
+        'INFO'      => 'ℹ️',
+        'NOTICE'    => '📌',
+        'WARNING'   => '⚠️',
+        'ERROR'     => '⚠️',
+        'CRITICAL'  => '🔥',
+        'ALERT'     => '🔔️',
+        'EMERGENCY' => '💀',
+    ],
+
 ];
 ```
 
@@ -63,8 +81,10 @@ Add the Logsnag channel to your logging config:
     'logsnag' => [
         'driver'  => 'custom',
         'via'     => ExpDev07\Logsnag\Logger\LogsnagLogger::class,
+        'level'   => 'debug',
         'project' => 'my-project',
         'channel' => 'my-channel',
+        'notify'  => true,         
     ],
 ];
 ```
@@ -107,6 +127,17 @@ app(LogsnagClient::class)->log(new LogsnagRequest(
 ));
 ```
 
+## Parameters
+
+* **project:** The logsnag project name.
+* **channel:** The channel to log in. Must be lowercase and hyphenated.
+* **event:** The event name.
+* **description:** The event description.
+* **icon:** Associate the log with an icon (emoji).
+* **notify:** Whether to send push notifications to devices.
+
+See [Logsnag Log](https://sh4yy.notion.site/LogSnag-API-e942b03305c94d4fa72c8a3d24a0ad49#eb98c978cec841d0ab50d52be6eb9f80) route for more information.
+
 ## Testing
 
 ```bash

config/logsnag.php

@@ -11,8 +11,28 @@
     |
     */
 
+    /**
+     * The project name.
+     */
     'project' => env('LOGSNAG_PROJECT', 'laravel'),
 
+    /**
+     * The API token.
+     */
     'token' => env('LOGSNAG_TOKEN', ''),
 
+    /**
+     * A mapping of icons for logging.
+     */
+    'icons' => [
+        'DEBUG'     => 'ℹ️',
+        'INFO'      => 'ℹ️',
+        'NOTICE'    => '📌',
+        'WARNING'   => '⚠️',
+        'ERROR'     => '⚠️',
+        'CRITICAL'  => '🔥',
+        'ALERT'     => '🔔️',
+        'EMERGENCY' => '💀',
+    ],
+
 ];

src/Client/LogsnagRequest.php

@@ -4,6 +4,9 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * A Logsnag logging request.
+ */
 class LogsnagRequest implements Arrayable
 {
 

src/Facades/Logsnag.php

@@ -10,7 +10,7 @@
  *
  * @see \ExpDev07\Logsnag\Logsnag
  *
- * @method static void log(string $channel, string $event)
+ * @method static void log(string $channel, string $event, string $description = null, string $icon = null, bool $notify = false)
  */
 class Logsnag extends Facade
 {

src/Logger/LogsnagHandler.php

@@ -3,10 +3,12 @@
 namespace ExpDev07\Logsnag\Logger;
 
 use ExpDev07\Logsnag\Facades\Logsnag;
+use Illuminate\Support\Str;
 use Monolog\Handler\AbstractProcessingHandler;
+use Monolog\Logger;
 
 /**
- *
+ * The Monolog processing handler.
  */
 class LogsnagHandler extends AbstractProcessingHandler
 {
@@ -18,16 +20,26 @@ class LogsnagHandler extends AbstractProcessingHandler
      */
     public string $channel;
 
+    /**
+     * Whether to send push notification.
+     *
+     * @var string
+     */
+    public string $notify;
+
     /**
      * Constructs a new monolog Logsnag handler.
      *
      * @param string $channel
+     * @param bool $notify
+     * @param int $level
      */
-    public function __construct(string $channel)
+    public function __construct(string $channel, bool $notify = false, int $level = Logger::DEBUG)
     {
-        parent::__construct();
+        parent::__construct($level);
 
         $this->channel = $channel;
+        $this->notify = $notify;
     }
 
     /**
@@ -37,7 +49,35 @@ public function __construct(string $channel)
      */
     protected function write(array $record): void
     {
-        Logsnag::log($this->channel, $record['formatted']);
+        Logsnag::log($this->channel,
+            event: $this->getEvent($record),
+            icon: $this->getIcon($record),
+            notify: $this->notify,
+        );
+    }
+
+    /**
+     * Gets the event for the record.
+     *
+     * @param array $record
+     * @return string
+     */
+    public function getEvent(array $record): string
+    {
+        return $record['formatted'];
+    }
+
+    /**
+     * Gets the icon for the record.
+     *
+     * @param array $record
+     * @return string|null
+     */
+    protected function getIcon(array $record): ?string
+    {
+        $icons = config('logsnag.icons');
+
+        return $icons[Str::upper($record['level_name'])] ?? null;
     }
 
 }

src/Logger/LogsnagLogger.php

@@ -2,9 +2,12 @@
 
 namespace ExpDev07\Logsnag\Logger;
 
-use Arr;
+use Illuminate\Support\Arr;
 use Monolog\Logger;
 
+/**
+ * The Laravel Logsnag logger.
+ */
 class LogsnagLogger
 {
 
@@ -16,9 +19,14 @@ class LogsnagLogger
      */
     public function __invoke(array $config): Logger
     {
-        [$channel] = $config;
+        // Create handler.
+        $handler = new LogsnagHandler(
+            channel: $config['channel'],
+            notify: $config['notify'] ?? false,
+            level: Logger::toMonologLevel($config['level'] ?? 'debug'),
+        );
 
-        return new Logger('logsnag', Arr::wrap(new LogsnagHandler($channel)));
+        return new Logger('logsnag', Arr::wrap($handler));
     }
 
 }

src/Logsnag.php

@@ -5,6 +5,9 @@
 use ExpDev07\Logsnag\Client\LogsnagClient;
 use ExpDev07\Logsnag\Client\LogsnagRequest;
 
+/**
+ * The Logsnag logger.
+ */
 class Logsnag
 {
 

src/LogsnagServiceProvider.php

@@ -6,6 +6,9 @@
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
+/**
+ * The Logsnag service provider.
+ */
 class LogsnagServiceProvider extends PackageServiceProvider
 {