diff --git a/ChangeLog b/ChangeLog index ad344c9f8d..a84e591035 100644 --- a/ChangeLog +++ b/ChangeLog @@ -43,6 +43,7 @@ phpMyAdmin - ChangeLog 4.9.2 (not yet released) - issue #15304 Fix ssl_use php error - issue #14804 Fix undefined index: ssl_* variables +- issue #14245 Fix mysql 8.0.3 and above fails on advisor 4.9.1 (2019-09-20) - issue #15313 Added support for Twig 2 diff --git a/libraries/advisory_rules.txt b/libraries/advisory_rules_generic.txt similarity index 85% rename from libraries/advisory_rules.txt rename to libraries/advisory_rules_generic.txt index c99fa0354f..5fd8b5a11b 100644 --- a/libraries/advisory_rules.txt +++ b/libraries/advisory_rules_generic.txt @@ -142,14 +142,6 @@ rule 'MySQL Architecture' # # Query cache -# Lame: 'ON' == 0 is true, so you need to compare 'ON' == '0' -rule 'Query cache disabled' - query_cache_size - value == 0 || query_cache_type == 'OFF' || query_cache_type == '0' - The query cache is not enabled. - The query cache is known to greatly improve performance if configured correctly. Enable it by setting {query_cache_size} to a 2 digit MiB value and setting {query_cache_type} to 'ON'. Note: If you are using memcached, ignore this recommendation. - query_cache_size is set to 0 or query_cache_type is set to 'OFF' - rule 'Query caching method' [!fired('Query cache disabled')] Questions / Uptime value > 100 @@ -157,48 +149,6 @@ rule 'Query caching method' [!fired('Query cache disabled')] You are using the MySQL Query cache with a fairly high traffic database. It might be worth considering to use memcached instead of the MySQL Query cache, especially if you have multiple slaves. The query cache is enabled and the server receives %d queries per second. This rule fires if there is more than 100 queries per second. | round(value,1) -rule 'Query cache efficiency (%)' [Com_select + Qcache_hits > 0 && !fired('Query cache disabled')] - Qcache_hits / (Com_select + Qcache_hits) * 100 - value < 20 - Query cache not running efficiently, it has a low hit rate. - Consider increasing {query_cache_limit}. - The current query cache hit rate of %s% is below 20% | round(value,1) - -rule 'Query Cache usage' [!fired('Query cache disabled')] - 100 - Qcache_free_memory / query_cache_size * 100 - value < 80 - Less than 80% of the query cache is being utilized. - This might be caused by {query_cache_limit} being too low. Flushing the query cache might help as well. - The current ratio of free query cache memory to total query cache size is %s%. It should be above 80% | round(value,1) - -rule 'Query cache fragmentation' [!fired('Query cache disabled')] - Qcache_free_blocks / (Qcache_total_blocks / 2) * 100 - value > 20 - The query cache is considerably fragmented. - Severe fragmentation is likely to (further) increase Qcache_lowmem_prunes. This might be caused by many Query cache low memory prunes due to {query_cache_size} being too small. For a immediate but short lived fix you can flush the query cache (might lock the query cache for a long time). Carefully adjusting {query_cache_min_res_unit} to a lower value might help too, e.g. you can set it to the average size of your queries in the cache using this formula: (query_cache_size - qcache_free_memory) / qcache_queries_in_cache - The cache is currently fragmented by %s% , with 100% fragmentation meaning that the query cache is an alternating pattern of free and used blocks. This value should be below 20%. | round(value,1) - -rule 'Query cache low memory prunes' [Qcache_inserts > 0 && !fired('Query cache disabled')] - Qcache_lowmem_prunes / Qcache_inserts * 100 - value > 0.1 - Cached queries are removed due to low query cache memory from the query cache. - You might want to increase {query_cache_size}, however keep in mind that the overhead of maintaining the cache is likely to increase with its size, so do this in small increments and monitor the results. - The ratio of removed queries to inserted queries is %s%. The lower this value is, the better (This rules firing limit: 0.1%) | round(value,1) - -rule 'Query cache max size' [!fired('Query cache disabled')] - query_cache_size - value > 1024 * 1024 * 128 - The query cache size is above 128 MiB. Big query caches may cause significant overhead that is required to maintain the cache. - Depending on your environment, it might be performance increasing to reduce this value. - Current query cache size: %s | ADVISOR_formatByteDown(value, 2, 2) - -rule 'Query cache min result size' [!fired('Query cache disabled')] - query_cache_limit - value == 1024*1024 - The max size of the result set in the query cache is the default of 1 MiB. - Changing {query_cache_limit} (usually by increasing) may increase efficiency. This variable determines the maximum size a query result may have to be inserted into the query cache. If there are many query results above 1 MiB that are well cacheable (many reads, little writes) then increasing {query_cache_limit} will increase efficiency. Whereas in the case of many query results being above 1 MiB that are not very well cacheable (often invalidated due to table updates) increasing {query_cache_limit} might reduce efficiency. - query_cache_limit is set to 1 MiB - # # Sorts rule 'Percentage of sorts that cause temporary tables' [Sort_scan + Sort_range > 0] diff --git a/libraries/advisory_rules_mysql_before80003.txt b/libraries/advisory_rules_mysql_before80003.txt new file mode 100644 index 0000000000..e28b7f41d3 --- /dev/null +++ b/libraries/advisory_rules_mysql_before80003.txt @@ -0,0 +1,57 @@ +# phpMyAdmin Advisory rules file +# +# See doc in advisory_rules_generic.txt +# + +# +# Query cache + +# Lame: 'ON' == 0 is true, so you need to compare 'ON' == '0' +rule 'Query cache disabled' + query_cache_size + value == 0 || query_cache_type == 'OFF' || query_cache_type == '0' + The query cache is not enabled. + The query cache is known to greatly improve performance if configured correctly. Enable it by setting {query_cache_size} to a 2 digit MiB value and setting {query_cache_type} to 'ON'. Note: If you are using memcached, ignore this recommendation. + query_cache_size is set to 0 or query_cache_type is set to 'OFF' + +rule 'Query cache efficiency (%)' [Com_select + Qcache_hits > 0 && !fired('Query cache disabled')] + Qcache_hits / (Com_select + Qcache_hits) * 100 + value < 20 + Query cache not running efficiently, it has a low hit rate. + Consider increasing {query_cache_limit}. + The current query cache hit rate of %s% is below 20% | round(value,1) + +rule 'Query Cache usage' [!fired('Query cache disabled')] + 100 - Qcache_free_memory / query_cache_size * 100 + value < 80 + Less than 80% of the query cache is being utilized. + This might be caused by {query_cache_limit} being too low. Flushing the query cache might help as well. + The current ratio of free query cache memory to total query cache size is %s%. It should be above 80% | round(value,1) + +rule 'Query cache fragmentation' [!fired('Query cache disabled')] + Qcache_free_blocks / (Qcache_total_blocks / 2) * 100 + value > 20 + The query cache is considerably fragmented. + Severe fragmentation is likely to (further) increase Qcache_lowmem_prunes. This might be caused by many Query cache low memory prunes due to {query_cache_size} being too small. For a immediate but short lived fix you can flush the query cache (might lock the query cache for a long time). Carefully adjusting {query_cache_min_res_unit} to a lower value might help too, e.g. you can set it to the average size of your queries in the cache using this formula: (query_cache_size - qcache_free_memory) / qcache_queries_in_cache + The cache is currently fragmented by %s% , with 100% fragmentation meaning that the query cache is an alternating pattern of free and used blocks. This value should be below 20%. | round(value,1) + +rule 'Query cache low memory prunes' [Qcache_inserts > 0 && !fired('Query cache disabled')] + Qcache_lowmem_prunes / Qcache_inserts * 100 + value > 0.1 + Cached queries are removed due to low query cache memory from the query cache. + You might want to increase {query_cache_size}, however keep in mind that the overhead of maintaining the cache is likely to increase with its size, so do this in small increments and monitor the results. + The ratio of removed queries to inserted queries is %s%. The lower this value is, the better (This rules firing limit: 0.1%) | round(value,1) + +rule 'Query cache max size' [!fired('Query cache disabled')] + query_cache_size + value > 1024 * 1024 * 128 + The query cache size is above 128 MiB. Big query caches may cause significant overhead that is required to maintain the cache. + Depending on your environment, it might be performance increasing to reduce this value. + Current query cache size: %s | ADVISOR_formatByteDown(value, 2, 2) + +rule 'Query cache min result size' [!fired('Query cache disabled')] + query_cache_limit + value == 1024*1024 + The max size of the result set in the query cache is the default of 1 MiB. + Changing {query_cache_limit} (usually by increasing) may increase efficiency. This variable determines the maximum size a query result may have to be inserted into the query cache. If there are many query results above 1 MiB that are well cacheable (many reads, little writes) then increasing {query_cache_limit} will increase efficiency. Whereas in the case of many query results being above 1 MiB that are not very well cacheable (often invalidated due to table updates) increasing {query_cache_limit} might reduce efficiency. + query_cache_limit is set to 1 MiB diff --git a/libraries/classes/Advisor.php b/libraries/classes/Advisor.php index 9ec85fd9db..6414979eac 100644 --- a/libraries/classes/Advisor.php +++ b/libraries/classes/Advisor.php @@ -18,6 +18,7 @@ use PhpMyAdmin\Url; use PhpMyAdmin\Util; use Symfony\Component\ExpressionLanguage\ExpressionLanguage; use Throwable; +use function array_merge_recursive; /** * Advisor class @@ -26,6 +27,9 @@ use Throwable; */ class Advisor { + public const GENERIC_RULES_FILE = 'libraries/advisory_rules_generic.txt'; + public const BEFORE_MYSQL80003_RULES_FILE = 'libraries/advisory_rules_mysql_before80003.txt'; + protected $dbi; protected $variables; protected $globals; @@ -230,8 +234,15 @@ class Advisor $this->variables['system_memory'] = isset($memory['MemTotal']) ? $memory['MemTotal'] : 0; + $ruleFiles = $this->defineRulesFiles(); + // Step 2: Read and parse the list of rules - $this->setParseResult(static::parseRulesFile()); + $parsedResults = []; + foreach ($ruleFiles as $ruleFile) { + $parsedResults[] = $this->parseRulesFile($ruleFile); + } + $this->setParseResult(array_merge_recursive(...$parsedResults)); + // Step 3: Feed the variables to the rules and let them fire. Sets // $runResult $this->runRules(); @@ -449,6 +460,22 @@ class Advisor $this->runResult[$type][] = $rule; } + /** + * Defines the rules files to use + * + * @return array + */ + protected function defineRulesFiles(): array + { + $isMariaDB = false !== strpos($this->getVariables()['version'], 'MariaDB'); + $ruleFiles = [self::GENERIC_RULES_FILE]; + // If MariaDB (= not MySQL) OR MYSQL < 8.0.3, add another rules file. + if ($isMariaDB || $this->globals['PMA_MYSQL_INT_VERSION'] < 80003) { + $ruleFiles[] = self::BEFORE_MYSQL80003_RULES_FILE; + } + return $ruleFiles; + } + /** * Callback for wrapping links with Core::linkURL * @@ -500,16 +527,16 @@ class Advisor * Reads the rule file into an array, throwing errors messages on syntax * errors. * + * @param string $filename Name of file to parse + * * @return array with parsed data */ - public static function parseRulesFile(): array + public static function parseRulesFile(string $filename): array { - $filename = 'libraries/advisory_rules.txt'; $file = file($filename, FILE_IGNORE_NEW_LINES); $errors = []; $rules = []; - $lines = []; if ($file === false) { $errors[] = sprintf( @@ -518,7 +545,6 @@ class Advisor ); return [ 'rules' => $rules, - 'lines' => $lines, 'errors' => $errors, ]; } @@ -559,10 +585,8 @@ class Advisor $ruleLine = 1; $ruleNo++; $rules[$ruleNo] = ['name' => $match[1]]; - $lines[$ruleNo] = ['name' => $i + 1]; if (isset($match[3])) { $rules[$ruleNo]['precondition'] = $match[3]; - $lines[$ruleNo]['precondition'] = $i + 1; } } else { $errors[] = sprintf( @@ -598,7 +622,6 @@ class Advisor $rules[$ruleNo][$ruleSyntax[$ruleLine]] = rtrim( mb_substr($line, 1) ); - $lines[$ruleNo][$ruleSyntax[$ruleLine]] = $i + 1; ++$ruleLine; } @@ -610,7 +633,6 @@ class Advisor return [ 'rules' => $rules, - 'lines' => $lines, 'errors' => $errors, ]; } diff --git a/test/classes/AdvisorTest.php b/test/classes/AdvisorTest.php index d06bfbcadd..cdddd1ca66 100644 --- a/test/classes/AdvisorTest.php +++ b/test/classes/AdvisorTest.php @@ -84,7 +84,7 @@ class AdvisorTest extends PmaTestCase public function testParse() { $advisor = new Advisor($GLOBALS['dbi'], new ExpressionLanguage()); - $parseResult = $advisor->parseRulesFile(); + $parseResult = $advisor->parseRulesFile(Advisor::GENERIC_RULES_FILE); $this->assertEquals($parseResult['errors'], []); } @@ -162,7 +162,7 @@ class AdvisorTest extends PmaTestCase public function testAddRule($rule, $expected, $error): void { $advisor = new Advisor($GLOBALS['dbi'], new ExpressionLanguage()); - $parseResult = $advisor->parseRulesFile(); + $parseResult = $advisor->parseRulesFile(Advisor::GENERIC_RULES_FILE); $this->assertEquals($parseResult['errors'], []); $advisor->setVariable('value', 0); $advisor->addRule('fired', $rule); diff --git a/test/classes/Controllers/Server/Status/MonitorControllerTest.php b/test/classes/Controllers/Server/Status/MonitorControllerTest.php index b755f6d0d4..c98ad4811b 100644 --- a/test/classes/Controllers/Server/Status/MonitorControllerTest.php +++ b/test/classes/Controllers/Server/Status/MonitorControllerTest.php @@ -63,6 +63,7 @@ class MonitorControllerTest extends TestCase "automatic_sp_privileges" => "ON", "back_log" => "50", "big_tables" => "OFF", + "version" => "8.0.2", ]; $fetchResult = [