MySQLTuner-perl

by major

MySQLTuner is a script written in Perl that will assist you with your MySQL configuration and make r...

6.3K Stars 1.0K Forks Last release: 12 months ago (1.7.17) GNU General Public License v3.0 1.0K Commits 12 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

MySQLTuner-perl

Build Status - Master Project Status Project Status Average time to resolve an issue Percentage of open issues GPL License

MySQLTuner is a script written in Perl that allows you to review a MySQL installation quickly and make adjustments to increase performance and stability. The current configuration variables and status data is retrieved and presented in a brief format along with some basic performance suggestions.

MySQLTuner supports ~300 indicators for MySQL/MariaDB/Percona Server in this last version.

MySQLTuner is maintained and indicator collect is increasing week after week supporting a lot of configuration such as Galera Cluster, TokuDB, Performance schema, Linux OS metrics, InnoDB, MyISAM, Aria, ...

You can find more details on these indicators here: Indicators description.

MysqlTuner

MySQLTuner needs you:

MySQLTuner needs contributors for documentation, code and feedback..

Stargazers over time

Compatibility

Test result are available here: Travis CI/MySQLTuner-perl * MySQL 8 (full support, password checks don't work) * MySQL 5.7 (full support) * MySQL 5.6 (full support) * MySQL 5.5 (full support) * MariaDB 10.4 (full support) * MariaDB 10.3 (full support) * MariaDB 10.2 (full support) * MariaDB 10.1 (full support) * MariaDB 10.0 (full support, 6 last month support) * MariaDB 5.5 (full support, no more MariaDB support) * Percona Server 8.0 (full support, password checks don't work) * Percona Server 5.7 (full support) * Percona Server 5.6 (full support)

  • Percona XtraDB cluster (partial support, no test environment)
  • Mysql Replications (partial support, no test environment)
  • Galera replication (partial support, no test environment)

  • MySQL 3.23, 4.0, 4.1, 5.0, 5.1, 5.5 (partial support - deprecated version)

*** UNSUPPORTED ENVIRONMENTS - NEED HELP FOR THAT :) *** * Windows is not supported at this time (Help wanted !!!!!) * Cloud based is not supported at this time (Help wanted !!!!!)

*** MINIMAL REQUIREMENTS ***

  • Perl 5.6 or later (with perl-doc package)
  • Unix/Linux based operating system (tested on Linux, BSD variants, and Solaris variants)
  • Unrestricted read access to the MySQL server (OS root access recommended for MySQL < 5.1)

WARNING

It is extremely important for you to fully understand each change you make to a MySQL database server. If you don't understand portions of the script's output, or if you don't understand the recommendations, you should consult a knowledgeable DBA or system administrator that you trust. Always test your changes on staging environments, and always keep in mind that improvements in one area can negatively affect MySQL in other areas.

It's also important to wait at least a day of uptime to get accurate results. In fact, running mysqltuner on a fresh restarted server is completely useless.

Seriously - please review the FAQ section below.

Security recommendations

Hi directadmin user! We detected that you run mysqltuner with da_admin's credentials taken from

/usr/local/directadmin/conf/my.cnf
, which might bring to a password discovery! Read link for more details Issue #289.

What MySQLTuner is checking exactly ?

All checks done by MySQLTuner are documented in MySQLTuner Internals documentation.

Download/Installation

Choose one of these methods:

1) Script direct download (the simplest and shortest method):

wget http://mysqltuner.pl/ -O mysqltuner.pl
wget https://raw.githubusercontent.com/major/MySQLTuner-perl/master/basic_passwords.txt -O basic_passwords.txt
wget https://raw.githubusercontent.com/major/MySQLTuner-perl/master/vulnerabilities.csv -O vulnerabilities.csv

2) You can download the entire repository by using

git clone
or
git clone --depth 1 -b master
followed by the cloning URL above.

Optional Sysschema installation for MySQL 5.6

Sysschema is installed by default under MySQL 5.7 and MySQL 8 from Oracle. By default, on MySQL 5.6/5.7/8, performance schema is enabled by default. For previous 5.6 version, you can follow this command to create a new database sys containing very useful view on Performance schema:

curl "https://codeload.github.com/mysql/mysql-sys/zip/master" > sysschema.zip
# check zip file
unzip -l sysschema.zip
unzip sysschema.zip
cd mysql-sys-master
mysql -uroot -p < sys_56.sql

Optional Performance schema and Sysschema installation for MariaDB 10.x

Sysschema is not installed by default under MariaDB 10.x. By default, on MariaDB, performance schema is disabled by default. consider activating performance schema across your my.cnf configuration file:

[mysqld]
performance_schema = on

You can follow this command to create a new database sys containing very useful view on Performance schema:

curl "https://codeload.github.com/FromDual/mariadb-sys/zip/master" > mariadb-sys.zip
# check zip file
unzip -l mariadb-sys.zip
unzip mariadb-sys.zip
cd mariadb-sys-master/
mysql -u root -p < ./sys_10.sql

Errors & solutions for performance schema installation

 ERROR at line 21: Failed to open file './tables/sys_config_data_10.sql -- ported', error: 2
 Have a look at #452 solution given by @ericx

Performance tips

Metadata statistic updates can impact strongly performance of database servers and MySQLTuner. Be sure that innodbstatson_metadata is disabled.

set global innodb_stats_on_metadata = 0;

Specific usage

Usage: Minimal usage locally

perl mysqltuner.pl --host 127.0.0.1

Of course, you can add the execute bit (

chmod +x mysqltuner.pl
) so you can execute it without calling perl directly.

Usage: Minimal usage remotely

perl mysqltuner.pl --host targetDNS_IP --user admin_user --pass admin_password

Usage: Enable maximum output information around MySQL/MariaDb without debugging

perl mysqltuner.pl --verbose
perl mysqltuner.pl --buffers --dbstat --idxstat --sysstat --pfstat --tbstat

Usage: Enable CVE vulnerabilities check for your MariaDB or MySQL version

perl mysqltuner.pl --cvefile=vulnerabilities.csv

Usage: Write your result in a file with information displayed

perl mysqltuner.pl --outputfile /tmp/result_mysqltuner.txt

Usage: Write your result in a file without outputting information

perl mysqltuner.pl --silent --outputfile /tmp/result_mysqltuner.txt

Usage: Using template model to customize your reporting file based on Text::Template syntax.

perl mysqltuner.pl --silent --reportfile /tmp/result_mysqltuner.txt --template=/tmp/mymodel.tmpl

Usage: Enable debugging information

perl mysqltuner.pl --debug

Usage: Update MySQLTuner and data files (password and cve) if needed

perl mysqltuner.pl --checkversion --updateversion

FAQ

Question: Will MySQLTuner fix my slow MySQL server?

No. MySQLTuner is a read only script. It won't write to any configuration files, change the status of any daemons, or call your mother to wish her a happy birthday. It will give you an overview of your server's performance and make some basic recommendations for improvements that you can make after it completes. Make sure you read the warning above prior to following any recommendations.

Question: Can I fire my DBA now?

MySQLTuner will not replace your DBA in any form or fashion. If your DBA constantly takes your parking spot and steals your lunch from the fridge, then you may want to consider it - but that's your call.

Question: Why does MySQLTuner keep asking me the login credentials for MySQL over and over?

The script will try its best to log in via any means possible. It will check for ~/.my.cnf files, Plesk password files, and empty password root logins. If none of those are available, then you'll be prompted for a password. If you'd like the script to run in an automated fashion without user intervention, then create a .my.cnf file in your home directory which contains:

[client]
user=someusername
password=thatuserspassword

Once you create it, make sure it's owned by your user and the mode on the file is 0600. This should prevent the prying eyes from getting your database login credentials under normal conditions. If a T-1000 shows up in a LAPD uniform and demands your database credentials, you won't have much of an option.

Question: Is there another way to secure credentials on latest MySQL and MariaDB distributions ?

You could use mysqlconfigeditor utilities. ~~~bash $ mysqlconfigeditor set --login-path=client --user=someusername --password --host=localhost Enter password: ******** ~~~ After which,

~/.mylogin.cnf
will be created with the appropriate access.

To get information about stored credentials, use the following command:

$mysql_config_editor print
[client]
user = someusername
password = *****
host = localhost

Question: What's minimum privileges needed by a specific mysqltuner user in database ?

    mysql>GRANT SELECT, PROCESS,EXECUTE, REPLICATION CLIENT,SHOW DATABASES,SHOW VIEW ON *.* TO 'mysqltuner'@'localhost' identified by pwd1234;

Question: It's not working on my OS! What gives?!

These kinds of things are bound to happen. Here are the details I need from you in order to research the problem thoroughly:

  • OS and OS version
  • Architecture (x86, x86_64, IA64, Commodore 64)
  • Exact MySQL version
  • Where you obtained your MySQL version (OS package, source, etc)
  • The full text of the error
  • A copy of SHOW VARIABLES and SHOW GLOBAL STATUS output (if possible)

Question: How to perform CVE vulnerability checks?

  • Download vulnerabilities.csv from this repository.
  • use option --cvefile to perform CVE checks

Question: How to use mysqltuner from a remote host? Thanks to @rolandomysqldba

  • You will still have to connect like a mysql client:

Connection and Authentication

--host  Connect to a remote host to perform tests (default: localhost)
--socket  Use a different socket for a local connection
--port      Port to use for connection (default: 3306)
--user  Username to use for authentication
--pass  Password to use for authentication
--defaults-file  defaults file for credentials

Since you are using a remote host, use parameters to supply values from the OS

--forcemem   Amount of RAM installed in megabytes
--forceswap  Amount of swap memory configured in megabytes
  • You may have to contact your remote SysAdmin to ask how much RAM and swap you have

If the database has too many tables, or very large table, use this:

--skipsize           Don't enumerate tables and their types/sizes (default: on)
                     (Recommended for servers with many tables)

Question: Can I install this project using homebrew on Apple Macintosh?

Yes!

brew install mysqltuner
can be used to install this application using homebrew on Apple Macintosh.

MySQLTuner and Vagrant

MySQLTuner contains following Vagrant configurations: * Fedora Core 30 / Docker

Vagrant File is stored in Vagrant subdirectory. * Follow following step after vagrant installation: $ vagrant up

MySQLTuner contains a Vagrant configurations for test purpose and development * Install VirtualBox and Vagrant * https://www.virtualbox.org/wiki/Downloads * https://www.vagrantup.com/downloads.html * Clone repository * git clone https://github.com/major/MySQLTuner-perl.git * Install Vagrant plugins vagrant-hostmanager and vagrant-vbguest * vagrant plugin install vagrant-hostmanager * vagrant plugin install vagrant-vbguest * Add Fedora Core 30 box for official Fedora Download Website * vagrant box add --name generic/fedora30 * Create a data directory * mkdir data

setup test environments

$ sh build/createTestEnvs.sh

$ source build/bashrc $ mysql_percona80 sakila sakila> ...

$ docker images mariadb 10.1 fc612450e1f1 12 days ago 352MB mariadb 10.2 027b7c57b8c6 12 days ago 340MB mariadb 10.3 47dff68107c4 12 days ago 343MB mariadb 10.4 92495405fc36 12 days ago 356MB mysql 5.6 95e0fc47b096 2 weeks ago 257MB mysql 5.7 383867b75fd2 2 weeks ago 373MB mysql 8.0 b8fd9553f1f0 2 weeks ago 445MB percona/percona-server 5.7 ddd245ed3496 5 weeks ago 585MB percona/percona-server 5.6 ed0a36e0cf1b 6 weeks ago 421MB percona/percona-server 8.0 390ae97d57c6 6 weeks ago 697MB mariadb 5.5 c7bf316a4325 4 months ago 352MB mariadb 10.0 d1bde56970c6 4 months ago 353MB mysql 5.5 d404d78aa797 4 months ago 205MB

$ docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES da2be9b050c9 mariadb:5.5 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:5311->3306/tcp mariadb55 5deca25d5ac8 mariadb:10.0 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:5310->3306/tcp mariadb100 73aaeb37e2c2 mariadb:10.1 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:5309->3306/tcp mariadb101 72ffa77e01ec mariadb:10.2 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:5308->3306/tcp mariadb102 f5996f2041df mariadb:10.3 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:5307->3306/tcp mariadb103 4890c52372bb mariadb:10.4 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:5306->3306/tcp mariadb104 6b9dc078e921 percona/percona-server:5.6 "/docker-entrypoint.…" 7 hours ago Up 7 hours 0.0.0.0:4308->3306/tcp percona56 3a4c7c826d4c percona/percona-server:5.7 "/docker-entrypoint.…" 7 hours ago Up 7 hours 0.0.0.0:4307->3306/tcp percona57 3dda408c91b0 percona/percona-server:8.0 "/docker-entrypoint.…" 7 hours ago Up 7 hours 33060/tcp, 0.0.0.0:4306->3306/tcp percona80 600a4e7e9dcd mysql:5.5 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:3309->3306/tcp mysql55 4bbe54342e5d mysql:5.6 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:3308->3306/tcp mysql56 a49783249a11 mysql:5.7 "docker-entrypoint.s…" 7 hours ago Up 7 hours 33060/tcp, 0.0.0.0:3307->3306/tcp mysql57 d985820667c2 mysql:8.0 "docker-entrypoint.s…" 7 hours ago Up 7 hours 0.0.0.0:3306->3306/tcp, 33060/tcp mysql 8 0

MySQLTuner needs you

MySQLTuner needs contributors for documentation, code and feedback..

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.