Skip to content

Laravel 10 support #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ composer.lock
coverage.xml
.phpstorm.meta.php
_ide_helper.php
_ide_helper_models.php.php
_ide_helper_models.php.php
.phpunit.result.cache
14 changes: 7 additions & 7 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
}
],
"require": {
"php": ">=7.1",
"illuminate/support": ">=5.6 <10",
"monolog/monolog": "^2"
"php": "^8.1",
"illuminate/support": "^10.0"
},
"require-dev": {
"orchestra/testbench": ">=5.0 <8",
"mockery/mockery": ">=1.0",
"nunomaduro/collision": ">=5.10 <7",
"jenssegers/mongodb": "^3.8"
"ext-mongodb": "*",
"orchestra/testbench": "^8.0",
"mockery/mockery": "^1.5",
"nunomaduro/collision": "^7.0",
"jenssegers/mongodb": "dev-master"
},
"suggest": {
"jenssegers/mongodb": "Adds support for MongoDB in Laravel/Eloquent"
Expand Down
17 changes: 3 additions & 14 deletions src/Jobs/SaveNewLogEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,21 @@
use Illuminate\Bus\Queueable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Monolog\LogRecord;

class SaveNewLogEvent implements ShouldQueue
{
use InteractsWithQueue, Queueable;

/**
* @var object
*/
protected $logToDb;

/**
* @var array
*/
protected $record;

/**
* Create a new job instance.
*
* @param object $logToDb
* @param array $record
* @param \Monolog\LogRecord $record
* @return void
*/
public function __construct($logToDb, $record)
public function __construct(protected $logToDb, protected LogRecord $record)
{
$this->logToDb = $logToDb;
$this->record = $record;
}

/**
Expand Down
23 changes: 19 additions & 4 deletions src/LogToDB.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use danielme85\LaravelLogToDB\Jobs\SaveNewLogEvent;
use danielme85\LaravelLogToDB\Models\DBLog;
use danielme85\LaravelLogToDB\Models\DBLogMongoDB;
use Monolog\LogRecord;

/**
* Class LogToDb
Expand Down Expand Up @@ -137,18 +138,32 @@ public function getModel()
/**
* Create a Eloquent Model
*
* @param $record
* @param \Monolog\LogRecord $record
* @return bool success
*/
public function newFromMonolog(array $record)
public function newFromMonolog(LogRecord $record)
{
$detailed = $this->getConfig('detailed');

if (!empty($this->connection)) {
if ($detailed && !empty($record['context']) && !empty($record['context']['exception'])) {
$record['context'] = self::parseIfException($record['context'], true);
$record = new LogRecord(
$record->datetime,
$record->channel,
$record->level,
$record->message,
self::parseIfException($record->context, true),
$record->extra
);
} else if (!$detailed) {
$record['context'] = null;
$record = new LogRecord(
$record->datetime,
$record->channel,
$record->level,
$record->message,
[],
$record->extra
);
}
if (!empty($this->config['queue'])) {
if (empty($this->config['queue_name']) && empty($this->config['queue_connection'])) {
Expand Down
25 changes: 14 additions & 11 deletions src/LogToDbCustomLoggingHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
use Monolog\Formatter\LineFormatter;
use Monolog\Handler\AbstractProcessingHandler;
use Monolog\Handler\ErrorLogHandler;
use Monolog\Logger;
use Monolog\LogRecord;

/**
* Class LogToDbHandler
Expand Down Expand Up @@ -52,27 +52,30 @@ function __construct(array $config,
/**
* Write the Log
*
* @param array $record
* @param \Monolog\LogRecord $record
* @throws DBLogException
*/
protected function write(array $record): void
protected function write(LogRecord $record): void
{
try {
$log = new LogToDB($this->config);
$log->newFromMonolog($record);
} catch (\Exception $e) {
$this->emergencyLog([
'message' => 'There was an error while trying to write the log to a DB, log record pushed to error_log()',
'level' => Logger::CRITICAL,
'level_name' => 'critical',
'context' => LogToDB::parseIfException(['exception' => $e]),
'extra' => []
]);

$this->emergencyLog(new LogRecord(
datetime: new \Monolog\DateTimeImmutable(true),
channel: '',
level: \Monolog\Level::Critical,
message: 'There was an error while trying to write the log to a DB, log record pushed to error_log()',
context: LogToDB::parseIfException(['exception' => $e]),
extra: []
));

$this->emergencyLog($record);
}
}

protected function emergencyLog(array $record)
protected function emergencyLog(LogRecord $record)
{
$errorHandler = new ErrorLogHandler();
$errorHandler->setFormatter(new LineFormatter('%level_name%: %message% %context%'));
Expand Down
35 changes: 11 additions & 24 deletions src/Models/LogToDbCreateObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

namespace danielme85\LaravelLogToDB\Models;

use Monolog\LogRecord;

/**
* Trait LogToDbCreateObject
*
Expand All @@ -12,33 +14,19 @@ trait LogToDbCreateObject
/**
* Create a new log object
*
* @param array $record
* @param \Monolog\LogRecord $record
*
* @return mixed
*/
public function generate(array $record)
public function generate(LogRecord $record)
{
if (isset($record['message'])) {
$this->message = $record['message'];
}
if (!empty($record['context'])) {
$this->context = $record['context'];
}
if (isset($record['level'])) {
$this->level = $record['level'];
}
if (isset($record['level_name'])) {
$this->level_name = $record['level_name'];
}
if (isset($record['channel'])) {
$this->channel = $record['channel'];
}
if (isset($record['datetime'])) {
$this->datetime = $record['datetime'];
}
if (!empty($record['extra'])) {
$this->extra = $record['extra'];
}
$this->message = $record->message;
$this->context = $record->context;
$this->level = $record->level->value;
$this->level_name = $record->level->getName();
$this->channel = $record->channel;
$this->datetime = $record->datetime;
$this->extra = $record->extra;
$this->unix_time = time();

return $this;
Expand Down Expand Up @@ -185,5 +173,4 @@ public function removeOlderThan(string $datetime)

return false;
}

}
5 changes: 3 additions & 2 deletions src/Processors/PhpVersionProcessor.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace danielme85\LaravelLogToDB\Processors;

use Monolog\LogRecord;
use Monolog\Processor\ProcessorInterface;

/**
Expand All @@ -11,9 +12,9 @@
class PhpVersionProcessor implements ProcessorInterface
{
/**
* @return array The processed record
* @return \Monolog\LogRecord The processed record
*/
public function __invoke(array $record) {
public function __invoke(LogRecord $record) {
$record['extra']['php_version'] = phpversion();

return $record;
Expand Down
2 changes: 1 addition & 1 deletion tests/FailureTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public function testEmergencyFailure()
ini_set('error_log', $backup);

$this->assertStringContainsString(
'critical: There was an error while trying to write the log to a DB',
'CRITICAL: There was an error while trying to write the log to a DB',
$result
);
$this->assertStringContainsString(
Expand Down
20 changes: 10 additions & 10 deletions tests/LogToDbTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Queue;
use danielme85\LaravelLogToDB\Jobs\SaveNewLogEvent;
use Monolog\LogRecord;

class LogToDbTest extends Orchestra\Testbench\TestCase
{
Expand Down Expand Up @@ -311,16 +312,15 @@ public function testQueue()
public function testSaveNewLogEventJob()
{
$logToDb = new LogToDB();
$record = [
'message' => 'job-test',
'context' => [],
'level' => 200,
'level_name' => 'INFO',
'channel' => 'local',
'datetime' => new Monolog\DateTimeImmutable(true),
'extra' => [],
'formatted' => "[2019-10-04T17:26:38.446827+00:00] local.INFO: test [] []\n"
];
$record = new LogRecord(
datetime: new \Monolog\DateTimeImmutable(true),
message: 'job-test',
context: [],
level: \Monolog\Level::Info,
channel: 'local',
extra: [],
formatted: "[2019-10-04T17:26:38.446827+00:00] local.INFO: test [] []\n"
);

$job = new SaveNewLogEvent($logToDb, $record);
$job->handle();
Expand Down