Merge pull request #147 from isangil/master
typo on a header (exactely -> exactly)
This commit is contained in:
Jean-Marie Renouard
commit
ea5668a94b
1 changed files with 165 additions and 165 deletions
330
README.md
330
README.md
|
|
@ -1,167 +1,167 @@
|
||||||
MySQLTuner-perl
|
MySQLTuner-perl
|
||||||
====
|
====
|
||||||
[](https://travis-ci.org/major/MySQLTuner-perl)
|
[](https://travis-ci.org/major/MySQLTuner-perl)
|
||||||
|
|
||||||
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 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.
|
||||||
|
|
||||||
Compatibility:
|
Compatibility:
|
||||||
|
|
||||||
* MySQL 5.7 (partial support)
|
* MySQL 5.7 (partial support)
|
||||||
* MySQL 5.6 (full support)
|
* MySQL 5.6 (full support)
|
||||||
* MariaDB 10.0 (full support)
|
* MariaDB 10.0 (full support)
|
||||||
* MariaDB 10.1 (partial support)
|
* MariaDB 10.1 (partial support)
|
||||||
* MySQL 5.5 (full support)
|
* MySQL 5.5 (full support)
|
||||||
* MySQL 5.1 (full support)
|
* MySQL 5.1 (full support)
|
||||||
* MySQL 3.23, 4.0, 4.1, 5.0, 5.1 (full support)
|
* MySQL 3.23, 4.0, 4.1, 5.0, 5.1 (full support)
|
||||||
* Perl 5.6 or later (with [perl-doc](http://search.cpan.org/~dapm/perl-5.14.4/pod/perldoc.pod) package)
|
* Perl 5.6 or later (with [perl-doc](http://search.cpan.org/~dapm/perl-5.14.4/pod/perldoc.pod) package)
|
||||||
* Unix/Linux based operating system (tested on Linux, BSD variants, and Solaris variants)
|
* Unix/Linux based operating system (tested on Linux, BSD variants, and Solaris variants)
|
||||||
* Windows is not supported at this time (Help wanted !!!!!)
|
* Windows is not supported at this time (Help wanted !!!!!)
|
||||||
* Unrestricted read access to the MySQL server (OS root access recommended for MySQL < 5.1)
|
* Unrestricted read access to the MySQL server (OS root access recommended for MySQL < 5.1)
|
||||||
* CVE vulnerabilites detection support from [https://cve.mitre.org](https://cve.mitre.org)
|
* CVE vulnerabilites detection support from [https://cve.mitre.org](https://cve.mitre.org)
|
||||||
|
|
||||||
***WARNING***
|
***WARNING***
|
||||||
--
|
--
|
||||||
It is **extremely important** for you to fully understand each change
|
It is **extremely important** for you to fully understand each change
|
||||||
you make to a MySQL database server. If you don't understand portions
|
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,
|
of the script's output, or if you don't understand the recommendations,
|
||||||
**you should consult** a knowledgeable DBA or system administrator
|
**you should consult** a knowledgeable DBA or system administrator
|
||||||
that you trust. **Always** test your changes on staging environments, and
|
that you trust. **Always** test your changes on staging environments, and
|
||||||
always keep in mind that improvements in one area can **negatively affect**
|
always keep in mind that improvements in one area can **negatively affect**
|
||||||
MySQL in other areas.
|
MySQL in other areas.
|
||||||
|
|
||||||
**Seriously - please review the FAQ section below.**
|
**Seriously - please review the FAQ section below.**
|
||||||
|
|
||||||
What MySQLTuner is checking exactely ?
|
What MySQLTuner is checking exactly ?
|
||||||
--
|
--
|
||||||
All checks done by **MySQLTuner** are documented in [MySQLTuner Internals](https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md) documentation.
|
All checks done by **MySQLTuner** are documented in [MySQLTuner Internals](https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md) documentation.
|
||||||
|
|
||||||
Download/Installation
|
Download/Installation
|
||||||
--
|
--
|
||||||
|
|
||||||
You can download the entire repository by using 'git clone' followed by the cloning URL above. The simplest and shortest method is:
|
You can download the entire repository by using 'git clone' followed by the cloning URL above. The simplest and shortest method is:
|
||||||
|
|
||||||
wget http://mysqltuner.pl/ -O mysqltuner.pl
|
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/basic_passwords.txt -O basic_passwords.txt
|
||||||
wget https://raw.githubusercontent.com/major/MySQLTuner-perl/master/vulnerabilities.csv -O vulnerabilities.csv
|
wget https://raw.githubusercontent.com/major/MySQLTuner-perl/master/vulnerabilities.csv -O vulnerabilities.csv
|
||||||
perl mysqltuner.pl
|
perl mysqltuner.pl
|
||||||
|
|
||||||
Of course, you can add the execute bit (`chmod +x mysqltuner.pl`) so you can execute it without calling perl directly.
|
Of course, you can add the execute bit (`chmod +x mysqltuner.pl`) so you can execute it without calling perl directly.
|
||||||
|
|
||||||
Specific usage
|
Specific usage
|
||||||
--
|
--
|
||||||
|
|
||||||
__Usage:__ Minimal usage locally
|
__Usage:__ Minimal usage locally
|
||||||
|
|
||||||
perl mysqltuner.pl
|
perl mysqltuner.pl
|
||||||
|
|
||||||
__Usage:__ Minimal usage remotely
|
__Usage:__ Minimal usage remotely
|
||||||
|
|
||||||
perl mysqltuner.pl --host targetDNS_IP --user admin_user --password admin_password
|
perl mysqltuner.pl --host targetDNS_IP --user admin_user --password admin_password
|
||||||
|
|
||||||
__Usage:__ Enable maximum output information around MySQL/MariaDb without debugging
|
__Usage:__ Enable maximum output information around MySQL/MariaDb without debugging
|
||||||
|
|
||||||
perl mysqltuner.pl --buffers --dbstat --idxstat
|
perl mysqltuner.pl --buffers --dbstat --idxstat
|
||||||
|
|
||||||
__Usage:__ Enable CVE vulnerabilities check for your MariaDB or MySQL version
|
__Usage:__ Enable CVE vulnerabilities check for your MariaDB or MySQL version
|
||||||
|
|
||||||
perl mysqltuner.pl --cvefile=vulnerabilities.csv
|
perl mysqltuner.pl --cvefile=vulnerabilities.csv
|
||||||
|
|
||||||
__Usage:__ Write your result in a file with information displayed
|
__Usage:__ Write your result in a file with information displayed
|
||||||
|
|
||||||
perl mysqltuner.pl --outputfile /tmp/result_mysqltuner.txt
|
perl mysqltuner.pl --outputfile /tmp/result_mysqltuner.txt
|
||||||
|
|
||||||
__Usage:__ Write your result in a file **without outputting information**
|
__Usage:__ Write your result in a file **without outputting information**
|
||||||
|
|
||||||
perl mysqltuner.pl --silent --outputfile /tmp/result_mysqltuner.txt
|
perl mysqltuner.pl --silent --outputfile /tmp/result_mysqltuner.txt
|
||||||
|
|
||||||
__Usage:__ Using template model to customize your reporting file based on [Text::Template](https://metacpan.org/pod/Text::Template) syntax.
|
__Usage:__ Using template model to customize your reporting file based on [Text::Template](https://metacpan.org/pod/Text::Template) syntax.
|
||||||
|
|
||||||
perl mysqltuner.pl --silent --reportfile /tmp/result_mysqltuner.txt --template=/tmp/mymodel.tmpl
|
perl mysqltuner.pl --silent --reportfile /tmp/result_mysqltuner.txt --template=/tmp/mymodel.tmpl
|
||||||
|
|
||||||
__Usage:__ Enable debugging information
|
__Usage:__ Enable debugging information
|
||||||
|
|
||||||
perl mysqltuner.pl --debug
|
perl mysqltuner.pl --debug
|
||||||
|
|
||||||
FAQ
|
FAQ
|
||||||
--
|
--
|
||||||
|
|
||||||
Question: Will MySQLTuner fix my slow MySQL server?
|
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 about improvements that you can make after it completes. *Make sure you read the warning above prior to following any recommendations.*
|
**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 about 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?
|
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.
|
**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?
|
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:
|
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]
|
[client]
|
||||||
user=someusername
|
user=someusername
|
||||||
pass=thatuserspassword
|
pass=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](https://en.wikipedia.org/wiki/T-1000) and demands your database credentials, you won't have much of an option.
|
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](https://en.wikipedia.org/wiki/T-1000) 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 ?
|
Question: Is there another way to secure credentials on latest MySQL and MariaDB distributions ?
|
||||||
|
|
||||||
You could use mysql_config_editor utilities.
|
You could use mysql_config_editor utilities.
|
||||||
|
|
||||||
$ mysql_config_editor set --login-path=client --user=someusername --password --host=localhost
|
$ mysql_config_editor set --login-path=client --user=someusername --password --host=localhost
|
||||||
Enter passord: ********
|
Enter passord: ********
|
||||||
$
|
$
|
||||||
|
|
||||||
At this time, ~/.mylogin.cnf has been written with appropriated rigth access.
|
At this time, ~/.mylogin.cnf has been written with appropriated rigth access.
|
||||||
|
|
||||||
To get information about stored credentials, use the following command:
|
To get information about stored credentials, use the following command:
|
||||||
|
|
||||||
$mysql_config_editor print
|
$mysql_config_editor print
|
||||||
[client]
|
[client]
|
||||||
user = someusername
|
user = someusername
|
||||||
password = *****
|
password = *****
|
||||||
host = localhost
|
host = localhost
|
||||||
|
|
||||||
Question: It's not working on my OS! What gives?!
|
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:
|
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
|
* OS and OS version
|
||||||
* Architecture (x86, x86_64, IA64, Commodore 64)
|
* Architecture (x86, x86_64, IA64, Commodore 64)
|
||||||
* Exact MySQL version
|
* Exact MySQL version
|
||||||
* Where you obtained your MySQL version (OS package, source, etc)
|
* Where you obtained your MySQL version (OS package, source, etc)
|
||||||
* The full text of the error
|
* The full text of the error
|
||||||
* A copy of SHOW VARIABLES and SHOW GLOBAL STATUS output (if possible)
|
* A copy of SHOW VARIABLES and SHOW GLOBAL STATUS output (if possible)
|
||||||
|
|
||||||
Question: How to perform a CVE vulneralibity checks ?
|
Question: How to perform a CVE vulneralibity checks ?
|
||||||
|
|
||||||
* Download vulnerabilities.csv from this repository.
|
* Download vulnerabilities.csv from this repository.
|
||||||
* use option --cvefile to perform CVE checks
|
* use option --cvefile to perform CVE checks
|
||||||
|
|
||||||
MySQLTuner and Vagrant
|
MySQLTuner and Vagrant
|
||||||
--
|
--
|
||||||
**MySQLTuner** contains a Vagrant configuration for test purpose and development
|
**MySQLTuner** contains a Vagrant configuration for test purpose and development
|
||||||
* Install VirtualBox and Vagrant
|
* Install VirtualBox and Vagrant
|
||||||
* https://www.virtualbox.org/wiki/Downloads
|
* https://www.virtualbox.org/wiki/Downloads
|
||||||
* https://www.vagrantup.com/downloads.html
|
* https://www.vagrantup.com/downloads.html
|
||||||
* Clone repository
|
* Clone repository
|
||||||
* git clone https://github.com/major/MySQLTuner-perl.git
|
* git clone https://github.com/major/MySQLTuner-perl.git
|
||||||
* Install Vagrant plugins vagrant-hostmanager and vagrant-vbguest
|
* Install Vagrant plugins vagrant-hostmanager and vagrant-vbguest
|
||||||
* vagrant plugin install vagrant-hostmanager
|
* vagrant plugin install vagrant-hostmanager
|
||||||
* vagrant plugin install vagrant-vbguest
|
* vagrant plugin install vagrant-vbguest
|
||||||
* Add Fedora Core 23 box for official Fedora Download Website
|
* Add Fedora Core 23 box for official Fedora Download Website
|
||||||
* vagrant box add --name fc23 https://download.fedoraproject.org/pub/fedora/linux/releases/23/Cloud/x86_64/Images/Fedora-Cloud-Base-Vagrant-23-20151030.x86_64.vagrant-virtualbox.box
|
* vagrant box add --name fc23 https://download.fedoraproject.org/pub/fedora/linux/releases/23/Cloud/x86_64/Images/Fedora-Cloud-Base-Vagrant-23-20151030.x86_64.vagrant-virtualbox.box
|
||||||
* Create a data directory
|
* Create a data directory
|
||||||
* mkdir data
|
* mkdir data
|
||||||
* Rename Vagrantfile_MariaDB10.0 into Vagrantfile
|
* Rename Vagrantfile_MariaDB10.0 into Vagrantfile
|
||||||
* cp MySQLTuner-perl/Vagrant/Vagrantfile_for_MariaDB10.0 Vagrantfile
|
* cp MySQLTuner-perl/Vagrant/Vagrantfile_for_MariaDB10.0 Vagrantfile
|
||||||
* Start vagrant
|
* Start vagrant
|
||||||
* vagrant up
|
* vagrant up
|
||||||
|
|
||||||
MySQLTuner needs you
|
MySQLTuner needs you
|
||||||
--
|
--
|
||||||
**MySQLTuner** needs contributors for documentation, code and feedbacks..
|
**MySQLTuner** needs contributors for documentation, code and feedbacks..
|
||||||
|
|
||||||
* Please join us on issue track at [GitHub tracker](https://github.com/major/MySQLTuner-perl/issues)</a>.
|
* Please join us on issue track at [GitHub tracker](https://github.com/major/MySQLTuner-perl/issues)</a>.
|
||||||
* Contribution guide is avalaible following [MySQLTuner contributing guide](https://github.com/major/MySQLTuner-perl/blob/master/CONTRIBUTING.md)
|
* Contribution guide is avalaible following [MySQLTuner contributing guide](https://github.com/major/MySQLTuner-perl/blob/master/CONTRIBUTING.md)
|
||||||
* Star **MySQLTuner project** at [MySQLTuner Git Hub Project](https://github.com/major/MySQLTuner-perl)
|
* Star **MySQLTuner project** at [MySQLTuner Git Hub Project](https://github.com/major/MySQLTuner-perl)
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue