Bulletproof logging for enterprise yii2 projects.
monolog 2.x integration, custom LogTarget with delayed queue, pretty console handler, logstash via udp and tcp with deep yii2 integration.
Features:
- uses monolog under the hood;
- implements custom log Target to pass log entries to monolog;
- allows handlers chaining if logstash handler fails, so no more loses of log entries;
- allows tracking statistics of log handlers;
- adds log context for messages and exceptions;
- doesn't turn off the whole log Target on errors;
- allows switching off handlers if they fail specific amount of times;
- supports stdout/stderr with colors;
- supports logstash tcp and udp transport;
- native support of yii log features.
Related packages you need to try:
- beter/exception-with-context is used by
yii2-beter-loggingpackage to bring support of context data storing in the exception. Check the doc. - yii2-log-request-response package contains component the component that logs user info, request related info, headers, execution time and so on for requests and response in CLI scripts and WEB.
The preferred way to install this extension is through composer.
Either run
composer require beter/yii2-beter-logging
or add
"beter/yii2-beter-logging": "~1.0.0" // add the latest version
to the require section of your composer.json.
To use this extension, you have to configure it in your application configuration.
Add Beter\Yii2\Logging\ProxyLogTarget class to the list of your log Targets
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'flushInterval' => 1,
'targets' => [
// other log targets
'monolog-proxy' => [
'class' => Beter\Yii2\Logging\ProxyLogTarget::class,
'targetLogComponent' => [
'componentName' => 'monolog',
'logChannel' => 'main'
],
'exportInterval' => 1,
'categories' => [],
'except' => [
'yii\web\UrlManager::parseRequest',
'yii\web\UrlRule::parseRequest',
],
'levels' => ['error', 'warning', 'info', 'trace'],
],
// other log targets
],
]
ProxyLogTarget extends yii\log\Target and supports
all settings that yii\log\Target has, but with limitations:
exportIntervalmust be 1.yii2-beter-loggingalways resets this setting to 1 and notifies about this. See details.logVars,maskVarsandprefixsettings will be ignored and will be reset to empty arrays and null values. See details.
The only additional setting is targetLogComponent section. This is not standard setting for yii2 log Target.
This section is mandatory and it connects Beter\Yii2\Logging\ProxyLogTarget with
Beter\Yii2\Logging\MonologComponent.
Beter\Yii2\Logging\MonologComponent may be configured with few monolog channels, but ProxyLogTarget
requires to specify the only one.
If you need more monolog channels you may setup few
ProxyLogTarget's.
Check further doc sections for more details.
Log Target passes log entries to Beter\Yii2\Logging\MonologComponent and then
Beter\Yii2\Logging\MonologComponent passes them to
Monolog\Logger.
Beter\Yii2\Logging\MonologComponent configures custom handlers shipped with yii2-beter-logging.
The list of handlers supported:
logstashstandard_streamfirephp
So, configure Beter\Yii2\Logging\MonologComponent class. Don't forget to use the same name of
the component and monolog channel name as was specified in targetLogComponent setting of the
Beter\Yii2\Logging\ProxyLogTarget ("monolog" and "main" in this example).
'monolog' => [
'class' => Beter\Yii2\Logging\MonologComponent::class,
'channels' => [
'main' => [
'handler' => [
[
'name' => 'logstash',
'label' => 'logstash',
'level' => 'debug',
'bubble' => true,
'host' => '1.2.3.4', // or host.address.com
'port' => 5045,
'socket_transport' => 'tcp',
'persistent' => false,
'socket_timeout' => 1,
'writing_timeout' => 1,
'connection_timeout' => 1,
'max_handle_errors_before_disabling' => 3,
'formatter' => [
'name' => 'logstash',
'trace_depth' => 10,
]
],
[
'name' => 'standard_stream',
'stream' => 'php://stderr',
'level' => 'debug',
'bubble' => true,
'formatter' => [
'name' => 'console',
'colorize' => true,
'indentSize' => 2,
'trace_depth' => 10,
]
],
[
'name' => 'firephp',
'bubble' => false,
'formatter' => [
'name' => 'wildfire',
]
],
],
'processor' => [
[
'name' => 'basic_processor',
'env' => YII_ENV, // dev, prod, etc
'app' => 'myapp',
'service' => 'api',
'exec_type' => 'web', // or cli, or etc
'host' => gethostname(), // or set it as you want
],
[
'name' => 'correlation_id_processor',
'length' => 32,
'search_in_headers' => true, // true if not set explicitly
'header_name' => 'X-Request-Id', // 'X-Request-Id' if not set explicitly
],
],
],
],
],
To not lose any log entries you need to
boostrap
Beter\Yii2\Logging\MonologComponent before any other component. log component must be the second component
in the list.
// other settings
'bootstrap' => [
'monolog',
'log',
'authManager',
// other components
],
// other settings
Don't forget to configure all your environments like cli and so on.
Just use log component and Yii::log()-related methods as usual
Yii::error('Error here', 'application'); // application is a category name
or
Yii::info('Info here', __METHOD__); // if you call from method
TBD:
- Handlers, Formatters and Processors
- Delayed errors
- Extending