Class ElasticLogger
Adapter to convert elastic logs to QueryLogger readable content
Property Summary
-
$_connection protected
Cake\ElasticSearch\Datasource\ConnectionHolds the connection instance
-
$_logger protected
Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterfaceHolds the logger instance
Method Summary
-
__construct() public
Constructor, set the QueryLogger instance
-
_log() protected
Format log messages from the Elastica client and pass them to the cake defined logger instance
-
alert() public
Action must be taken immediately.
-
critical() public
Critical conditions.
-
debug() public
Detailed debug information.
-
emergency() public
System is unusable.
-
error() public
Runtime errors that do not require immediate action but should typically be logged and monitored.
-
getLogger() public
Return the current logger
-
info() public
Interesting events.
-
log() public
Format log messages from the Elastica client _log method
-
notice() public
Normal but significant events.
-
setLogger() public
Set the current cake logger
-
warning() public
Exceptional occurrences that are not errors.
Method Detail
__construct() ¶ public
__construct(Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterface $logger, Cake\ElasticSearch\Datasource\Connection $connection)Constructor, set the QueryLogger instance
Parameters
-
Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterface$logger Instance of the QueryLogger
-
Cake\ElasticSearch\Datasource\Connection$connection Current connection instance
_log() ¶ protected
_log(string $level, string $message, array $context = []): voidFormat log messages from the Elastica client and pass them to the cake defined logger instance
Elastica's log parameters
error: message: "Elastica Request Failure" context: [ exception, request, retry ] debug (request): message: "Elastica Request" context: [ request, response, responseStatus, query ] debug (fallback?): message: "Elastica Request" context: [ message, query ]
Parameters
-
string$level The log level
-
string$message The log message
-
array$context optional log context
Returns
voidalert() ¶ public
alert(stringStringable $message, mixed[] $context = []): voidAction must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
Parameters
-
stringStringable$message -
mixed[]$context optional
Returns
voidcritical() ¶ public
critical(stringStringable $message, mixed[] $context = []): voidCritical conditions.
Example: Application component unavailable, unexpected exception.
Parameters
-
stringStringable$message -
mixed[]$context optional
Returns
voiddebug() ¶ public
debug(stringStringable $message, mixed[] $context = []): voidDetailed debug information.
Parameters
-
stringStringable$message -
mixed[]$context optional
Returns
voidemergency() ¶ public
emergency(stringStringable $message, mixed[] $context = []): voidSystem is unusable.
Parameters
-
stringStringable$message -
mixed[]$context optional
Returns
voiderror() ¶ public
error(stringStringable $message, mixed[] $context = []): voidRuntime errors that do not require immediate action but should typically be logged and monitored.
Parameters
-
stringStringable$message -
mixed[]$context optional
Returns
voidgetLogger() ¶ public
getLogger(): Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterfaceReturn the current logger
Returns
Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterfaceinfo() ¶ public
info(stringStringable $message, mixed[] $context = []): voidInteresting events.
Example: User logs in, SQL logs.
Parameters
-
stringStringable$message -
mixed[]$context optional
Returns
voidlog() ¶ public
log(mixed $level, Stringable|string $message, mixed[] $context = []): voidFormat log messages from the Elastica client _log method
Parameters
-
mixed$level The log level
-
Stringable|string$message The log message
-
mixed[]$context optional log context
Returns
voidnotice() ¶ public
notice(stringStringable $message, mixed[] $context = []): voidNormal but significant events.
Parameters
-
stringStringable$message -
mixed[]$context optional
Returns
voidsetLogger() ¶ public
setLogger(Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterface $logger): $thisSet the current cake logger
Parameters
-
Cake\Database\Log\QueryLoggerPsr\Log\LoggerInterface$logger Set logger instance to pass logging data to
Returns
$thiswarning() ¶ public
warning(stringStringable $message, mixed[] $context = []): voidExceptional occurrences that are not errors.
Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
Parameters
-
stringStringable$message -
mixed[]$context optional
Returns
void