Add option to control error and query log consolidation

This commit is contained in:
Kijin Sung 2023-05-01 02:59:22 +09:00
parent 3bf458e9ba
commit 58ce0defca
8 changed files with 90 additions and 41 deletions

View file

@ -2,7 +2,7 @@
/**
* Default configuration for Rhymix
*
*
* Copyright (c) Rhymix Developers and Contributors
*/
return array(
@ -103,6 +103,7 @@ return array(
'display_to' => 'admin',
'query_comment' => false,
'query_full_stack' => false,
'consolidate' => true,
'write_error_log' => 'fatal',
'allow' => array(),
),

View file

@ -286,15 +286,23 @@ class Debug
'type' => 'Debug',
);
// Only add the same entry once.
$key = hash_hmac('sha1', serialize([$entry->message, $entry->file, $entry->line]), config('crypto.authentication_key'));
if (isset(self::$_entries[$key]))
// Consolidate entries.
if (!isset(self::$_config['consolidate']) || self::$_config['consolidate'] === true)
{
self::$_entries[$key]->count++;
$key = hash_hmac('sha1', serialize([$entry->message, $entry->file, $entry->line]), config('crypto.authentication_key'));
if (isset(self::$_entries[$key]))
{
self::$_entries[$key]->count++;
}
else
{
self::$_entries[$key] = $entry;
}
}
else
{
self::$_entries[$key] = $entry;
$entry->count = 0;
self::$_entries[] = $entry;
}
// Add the entry to the error log.
@ -354,14 +362,22 @@ class Debug
);
// If the same error is repeated, only increment the counter.
$key = hash_hmac('sha1', serialize([$errinfo->message, $errinfo->file, $errinfo->line]), config('crypto.authentication_key'));
if (isset(self::$_errors[$key]))
if (!isset(self::$_config['consolidate']) || self::$_config['consolidate'] === true)
{
self::$_errors[$key]->count++;
$key = hash_hmac('sha1', serialize([$errinfo->message, $errinfo->file, $errinfo->line]), config('crypto.authentication_key'));
if (isset(self::$_errors[$key]))
{
self::$_errors[$key]->count++;
}
else
{
self::$_errors[$key] = $errinfo;
}
}
else
{
self::$_errors[$key] = $errinfo;
$errinfo->count = 0;
self::$_errors[] = $errinfo;
}
// Add the entry to the error log.
@ -402,25 +418,34 @@ class Debug
'type' => 'Query',
);
// Generate a unique key for this query.
$key = hash_hmac('sha1', serialize([
$query_object->query_id,
$query_object->query_string,
$query_object->query_connection,
$query_object->file,
$query_object->line,
$query_object->method,
]), config('crypto.authentication_key'));
// If the same query is repeated, only increment the counter.
if (isset(self::$_queries[$key]))
// Consolidate repeated queries.
if (!isset(self::$_config['consolidate']) || self::$_config['consolidate'] === true)
{
self::$_queries[$key]->query_time += $query_object->query_time;
self::$_queries[$key]->count++;
// Generate a unique key for this query.
$key = hash_hmac('sha1', serialize([
$query_object->query_id,
$query_object->query_string,
$query_object->query_connection,
$query_object->file,
$query_object->line,
$query_object->method,
]), config('crypto.authentication_key'));
// If the same query is repeated, only increment the counter.
if (isset(self::$_queries[$key]))
{
self::$_queries[$key]->query_time += $query_object->query_time;
self::$_queries[$key]->count++;
}
else
{
self::$_queries[$key] = $query_object;
}
}
else
{
self::$_queries[$key] = $query_object;
$query_object->count = 0;
self::$_queries[] = $query_object;
}
// Record query time.
@ -439,17 +464,26 @@ class Debug
'type' => 'Query Error',
);
// If the same query error is repeated, only increment the counter.
$key = hash_hmac('sha1', serialize(['QUERY ERROR', $error_object->message, $error_object->file, $error_object->line]), config('crypto.authentication_key'));
if (isset(self::$_errors[$key]))
// Consolidate repeated queries.
if (!isset(self::$_config['consolidate']) || self::$_config['consolidate'] === true)
{
self::$_errors[$key]->count++;
$key = hash_hmac('sha1', serialize(['QUERY ERROR', $error_object->message, $error_object->file, $error_object->line]), config('crypto.authentication_key'));
if (isset(self::$_errors[$key]))
{
self::$_errors[$key]->count++;
}
else
{
self::$_errors[$key] = $error_object;
}
}
else
{
self::$_errors[$key] = $error_object;
$error_object->count = 0;
self::$_errors[] = $error_object;
}
// Add the entry to the error log.
if (self::$_config['write_error_log'] === 'all')
{
$log_entry = strtr(sprintf('Query Error: %s in %s on line %d', $error_object->message, $error_object->file, intval($error_object->line)), "\0\r\n\t\v\e\f", ' ');

View file

@ -100,7 +100,7 @@ $(function() {
if (data.entries[i].backtrace[j].file) {
backtrace.append($('<li></li>').text(
data.entries[i].backtrace[j].file + ":" + data.entries[i].backtrace[j].line +
(j == 0 ? (" (×" + data.entries[i].count + ")") : "")
((j == 0 && data.entries[i].count > 1) ? (" (×" + data.entries[i].count + ")") : "")
));
}
}
@ -119,7 +119,7 @@ $(function() {
if (data.errors[i].backtrace[j].file) {
backtrace.append($('<li></li>').text(
data.errors[i].backtrace[j].file + ":" + data.errors[i].backtrace[j].line +
(j == 0 ? (" (×" + data.errors[i].count + ")") : "")
((j == 0 && data.errors[i].count > 1) ? (" (×" + data.errors[i].count + ")") : "")
));
}
}
@ -137,7 +137,7 @@ $(function() {
if (data.queries[i].file && data.queries[i].line) {
description.append($('<li></li>').text("Caller: " +
data.queries[i].file + ":" + data.queries[i].line +
(" (×" + data.queries[i].count + ")")
(data.queries[i].count > 1 ? (" (×" + data.queries[i].count + ")") : "")
).append("<br>(" + data.queries[i].method + ")"));
description.append($('<li></li>').text("Connection: " + data.queries[i].query_connection));
description.append($('<li></li>').text("Query ID: " + data.queries[i].query_id));

View file

@ -57,7 +57,7 @@ Debug Entries
if (isset($backtrace['file']) && isset($backtrace['line']))
{
echo sprintf(' - %s line %d', $backtrace['file'], $backtrace['line']);
if ($is_first_entry)
if ($is_first_entry && $entry->count > 1)
{
echo ' (×' . $entry->count . ')';
$is_first_entry = false;
@ -87,7 +87,7 @@ PHP Errors and Warnings
if (isset($backtrace['file']) && isset($backtrace['line']))
{
echo sprintf(' - %s line %d', $backtrace['file'], $backtrace['line']);
if ($is_first_error)
if ($is_first_error && $error->count > 1)
{
echo ' (×' . $error->count . ')';
$is_first_error = false;
@ -115,7 +115,7 @@ Database Queries
echo sprintf('%02d. %s', ++$query_count, $query->query_string) . "\n";
if (empty($query->backtrace))
{
echo sprintf(' - Caller: %s', $query_caller) . ' (×' . $query->count . ')' . "\n";
echo sprintf(' - Caller: %s', $query_caller) . ($query->count > 1 ? (' (×' . $query->count . ')') : '') . "\n";
}
echo sprintf(' - Connection: %s', $query->query_connection) . "\n";
echo sprintf(' - Query ID: %s', $query->query_id) . "\n";
@ -123,7 +123,7 @@ Database Queries
echo sprintf(' - Result: %s', $query_result) . "\n";
if (!empty($query->backtrace))
{
echo sprintf(' - Call Stack: %s', $query_caller) . ' (×' . $query->count . ')' . "\n";
echo sprintf(' - Call Stack: %s', $query_caller) . ($query->count > 1 ? (' (×' . $query->count . ')') : '') . "\n";
foreach ($query->backtrace ?? [] as $key => $backtrace)
{
if (isset($backtrace['file']) && isset($backtrace['line']))