Skip to content

resolve #28 JsonFormatterを拡張して利用するパターンを追加 #33

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.

Sign up for GitHub

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 5 commits into from
Jun 6, 2018
Merged

resolve #28 JsonFormatterを拡張して利用するパターンを追加 #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b7a006d
resolve #28
keitakn Jun 6, 2018
426af67
resolve #28
keitakn Jun 6, 2018
2672847
add #28 Confirm that "JsonFormatter" can be extended and used
keitakn Jun 6, 2018
2eeaec5
add #28 PHPDoc
keitakn Jun 6, 2018
6974a62
add #28 Extend and use `\Nekonomokochan\PhpJsonLogger\JsonFormatter`
keitakn Jun 6, 2018
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
162 changes: 162 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,5 +199,167 @@ These are the same as `logLevel` defined in [Monolog](https://github.com/Seldaek
- ALERT = 550
- EMERGENCY = 600

### Extend and use `\Nekonomokochan\PhpJsonLogger\JsonFormatter`

You can make your own `\Monolog\Logger` using only `\Nekonomokochan\PhpJsonLogger\JsonFormatter`.

This method is useful when you need `\Monolog\Logger` in web application framework(e.g. [Laravel](https://github.com/laravel/laravel)).

The following is sample code.

```php
<?php
use Monolog\Logger;
use Monolog\Handler\RotatingFileHandler;
use Monolog\Processor\IntrospectionProcessor;
use Nekonomokochan\PhpJsonLogger\JsonFormatter;

$logFileName = '/tmp/extended-monolog-test.log';

// create extendedMonolog Instance
$formatter = new JsonFormatter();

$rotating = new RotatingFileHandler(
$logFileName,
7,
Logger::INFO
);
$rotating->setFormatter($formatter);

$introspection = new IntrospectionProcessor(
Logger::INFO,
['Nekonomokochan\\PhpJsonLogger\\'],
0
);

$extraRecords = function ($record) {
$record['extra']['trace_id'] = 'ExtendedMonologTestTraceId';
$record['extra']['created_time'] = microtime(true);

return $record;
};

$extendedMonolog = new Logger(
'ExtendedMonolog',
[$rotating],
[$introspection, $extraRecords]
);

// output info log
$context = [
'cat' => '🐱',
'dog' => '🐶',
'rabbit' => '🐰',
];

$extendedMonolog->info('outputInfoLogTest', $context);
```

It is output to `extended-monolog-test-yyyy-mm-dd.log` as follows

```json
{
"log_level": "INFO",
"message": "outputInfoLogTest",
"trace_id": "ExtendedMonologTestTraceId",
"file": "\/home\/vagrant\/php-json-logger\/tests\/ExtendedMonologTest.php",
"line": 85,
"context": {
"cat": "🐱",
"dog": "🐶",
"rabbit": "🐰"
},
"remote_ip_address": "127.0.0.1",
"user_agent": "unknown",
"datetime": "2018-06-06 17:14:26.042013",
"timezone": "Asia\/Tokyo",
"process_time": 0.1678466796875
}
```

The following code is necessary to output `trace_id` and `process_time`.

```php
$extraRecords = function ($record) {
$record['extra']['trace_id'] = 'ExtendedMonologTestTraceId';
$record['extra']['created_time'] = microtime(true);

return $record;
};
```

The code below is the code necessary to normally display the stack trace with JSON.

```php
$introspection = new IntrospectionProcessor(
Logger::INFO,
['Nekonomokochan\\PhpJsonLogger\\'],
0
);
```

To output the stack trace to the log, execute the following code.

```php
$exception = new \Exception('ExtendedMonologTest.outputErrorLog', 500);
$context = [
'cat' => '🐱(=^・^=)🐱',
'dog' => '🐶Uo･ｪ･oU🐶',
'rabbit' => '🐰🐰🐰',
];

$extendedMonolog->error(
get_class($exception),
$this->formatPhpJsonLoggerErrorsContext($exception, $context)
);
```

Please pay attention to the part `$this->formatPhpJsonLoggerErrorsContext($exception, $context)`.

This is necessary processing to format the error log into JSON and output it.

This is the method implemented in `\Nekonomokochan\PhpJsonLogger\ErrorsContextFormat`.

It is output to `extended-monolog-test-yyyy-mm-dd.log` as follows.

```json
{
"log_level": "ERROR",
"message": "Exception",
"trace_id": "ExtendedMonologTestTraceId",
"file": "\/home\/vagrant\/php-json-logger\/tests\/ExtendedMonologTest.php",
"line": 126,
"context": {
"cat": "🐱(=^・^=)🐱",
"dog": "🐶Uo･ｪ･oU🐶",
"rabbit": "🐰🐰🐰"
},
"remote_ip_address": "127.0.0.1",
"user_agent": "unknown",
"datetime": "2018-06-06 17:37:57.440757",
"timezone": "Asia\/Tokyo",
"process_time": 0.16093254089355469,
"errors": {
"message": "ExtendedMonologTest.outputErrorLog",
"code": 500,
"file": "\/home\/vagrant\/php-json-logger\/tests\/ExtendedMonologTest.php",
"line": 117,
"trace": [
"#0 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/src\/Framework\/TestCase.php(1145): Nekonomokochan\\Tests\\ExtendedMonologTest->outputErrorLog()",
"#1 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/src\/Framework\/TestCase.php(840): PHPUnit\\Framework\\TestCase->runTest()",
"#2 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/src\/Framework\/TestResult.php(645): PHPUnit\\Framework\\TestCase->runBare()",
"#3 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/src\/Framework\/TestCase.php(798): PHPUnit\\Framework\\TestResult->run()",
"#4 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/src\/Framework\/TestSuite.php(776): PHPUnit\\Framework\\TestCase->run()",
"#5 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/src\/TextUI\/TestRunner.php(529): PHPUnit\\Framework\\TestSuite->run()",
"#6 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/src\/TextUI\/Command.php(198): PHPUnit\\TextUI\\TestRunner->doRun()",
"#7 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/src\/TextUI\/Command.php(151): PHPUnit\\TextUI\\Command->run()",
"#8 \/home\/vagrant\/php-json-logger\/vendor\/phpunit\/phpunit\/phpunit(53): PHPUnit\\TextUI\\Command::main()"
]
}
}
```

If you want to know more detailed usage, please look at `php-json-logger/tests/ExtendedMonologTest.php`.

## License
MIT
5 changes: 5 additions & 0 deletions src/PhpJsonLogger/ErrorsContextFormat.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
<?php
namespace Nekonomokochan\PhpJsonLogger;

/**
* Trait ErrorsContextFormat
*
* @package Nekonomokochan\PhpJsonLogger
*/
trait ErrorsContextFormat
{
/**
Expand Down
160 changes: 160 additions & 0 deletions tests/ExtendedMonologTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
<?php
namespace Nekonomokochan\Tests;

use Monolog\Handler\RotatingFileHandler;
use Monolog\Logger;
use Monolog\Processor\IntrospectionProcessor;
use Nekonomokochan\PhpJsonLogger\ErrorsContextFormat;
use Nekonomokochan\PhpJsonLogger\JsonFormatter;
use PHPUnit\Framework\TestCase;

/**
* Class ExtendedMonologTest
*
* @package Nekonomokochan\Tests
*/
class ExtendedMonologTest extends TestCase
{
use ErrorsContextFormat;

/**
* @var string
*/
private $logFileName = '/tmp/extended-monolog-test.log';

/**
* @var Logger
*/
private $extendedMonolog;

/**
* create extendedMonolog Instance
*
* @throws \Exception
*/
public function setUp()
{
parent::setUp();
// Delete the log file to assert the log file
$defaultFile = '/tmp/extended-monolog-test-' . date('Y-m-d') . '.log';
if (file_exists($defaultFile)) {
unlink($defaultFile);
}

// create extendedMonolog Instance
$formatter = new JsonFormatter();

$rotating = new RotatingFileHandler(
$this->logFileName,
7,
Logger::INFO
);
$rotating->setFormatter($formatter);

$introspection = new IntrospectionProcessor(
Logger::INFO,
['Nekonomokochan\\PhpJsonLogger\\'],
0
);

$extraRecords = function ($record) {
$record['extra']['trace_id'] = 'ExtendedMonologTestTraceId';
$record['extra']['created_time'] = microtime(true);

return $record;
};

$this->extendedMonolog = new Logger(
'ExtendedMonolog',
[$rotating],
[$introspection, $extraRecords]
);
}

/**
* @test
*/
public function outputInfoLog()
{
$context = [
'cat' => '🐱',
'dog' => '🐶',
'rabbit' => '🐰',
];

$this->extendedMonolog->info('outputInfoLogTest', $context);

$resultJson = file_get_contents('/tmp/extended-monolog-test-' . date('Y-m-d') . '.log');
$resultArray = json_decode($resultJson, true);

echo "\n ---- Output Log Begin ---- \n";
echo json_encode($resultArray, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT);
echo "\n ---- Output Log End ---- \n";

$expectedLog = [
'log_level' => 'INFO',
'message' => 'outputInfoLogTest',
'trace_id' => 'ExtendedMonologTestTraceId',
'file' => __FILE__,
'line' => 85,
'context' => $context,
'remote_ip_address' => '127.0.0.1',
'user_agent' => 'unknown',
'datetime' => $resultArray['datetime'],
'timezone' => date_default_timezone_get(),
'process_time' => $resultArray['process_time'],
];

$this->assertSame('ExtendedMonolog', $this->extendedMonolog->getName());
$this->assertSame($expectedLog, $resultArray);
}

/**
* @test
*/
public function outputErrorLog()
{
$exception = new \Exception('ExtendedMonologTest.outputErrorLog', 500);
$context = [
'cat' => '🐱(=^・^=)🐱',
'dog' => '🐶Uo･ｪ･oU🐶',
'rabbit' => '🐰🐰🐰',
];

$this->extendedMonolog->error(
get_class($exception),
$this->formatPhpJsonLoggerErrorsContext($exception, $context)
);

$resultJson = file_get_contents('/tmp/extended-monolog-test-' . date('Y-m-d') . '.log');
$resultArray = json_decode($resultJson, true);

echo "\n ---- Output Log Begin ---- \n";
echo json_encode($resultArray, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT);
echo "\n ---- Output Log End ---- \n";

$expectedLog = [
'log_level' => 'ERROR',
'message' => get_class($exception),
'trace_id' => 'ExtendedMonologTestTraceId',
'file' => __FILE__,
'line' => 126,
'context' => $context,
'remote_ip_address' => '127.0.0.1',
'user_agent' => 'unknown',
'datetime' => $resultArray['datetime'],
'timezone' => date_default_timezone_get(),
'process_time' => $resultArray['process_time'],
'errors' => [
'message' => $exception->getMessage(),
'code' => $exception->getCode(),
'file' => $exception->getFile(),
'line' => $exception->getLine(),
'trace' => $resultArray['errors']['trace'],
],
];

$this->assertSame('ExtendedMonolog', $this->extendedMonolog->getName());
$this->assertSame($expectedLog, $resultArray);
}
}