hhf/MySQLTuner-perl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #366 from joncav/master

Browse source 
Spelling & Grammar
This commit is contained in:
Jean-Marie Renouard 2018-01-10 15:03:34 +01:00 committed by GitHub
commit c535405966
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
README.md
View file

@ -4,14 +4,14 @@ MySQLTuner-perl
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges) [![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
[![Project Status](http://opensource.box.com/badges/maintenance.svg)](http://opensource.box.com/badges) [![Project Status](http://opensource.box.com/badges/maintenance.svg)](http://opensource.box.com/badges)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/major/MySQLTuner-perl.svg)](http://isitmaintained.com/project/major/MySQLTuner-perl "Average time to resolve an issue") [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/major/MySQLTuner-perl.svg)](http://isitmaintained.com/project/major/MySQLTuner-perl "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/major/MySQLTuner-perl.svg)](http://isitmaintained.com/project/major/MySQLTuner-perl "Percentage of issues still open") [![Percentage of open issues](http://isitmaintained.com/badge/open/major/MySQLTuner-perl.svg)](http://isitmaintained.com/project/major/MySQLTuner-perl "Percentage of issues still open")
[![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.png?v=103)](https://opensource.org/licenses/GPL-3.0/) [![GPL License](https://badges.frapsoft.com/os/gpl/gpl.png?v=103)](https://opensource.org/licenses/GPL-3.0/)
**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.
**MySQLTuner** supports in this last version ~300 indicators for MySQL/MariaDB/Percona Server. **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](http://galeracluster.com/), [TokuDB](https://www.percona.com/software/mysql-database/percona-tokudb), [Performance schema](https://github.com/mysql/mysql-sys), Linux OS metrics, [InnoDB](http://dev.mysql.com/doc/refman/5.7/en/innodb-storage-engine.html), [MyISAM](http://dev.mysql.com/doc/refman/5.7/en/myisam-storage-engine.html), [Aria](https://mariadb.com/kb/en/mariadb/aria/), ... **MySQLTuner** is maintained and indicator collect is increasing week after week supporting a lot of configuration such as [Galera Cluster](http://galeracluster.com/), [TokuDB](https://www.percona.com/software/mysql-database/percona-tokudb), [Performance schema](https://github.com/mysql/mysql-sys), Linux OS metrics, [InnoDB](http://dev.mysql.com/doc/refman/5.7/en/innodb-storage-engine.html), [MyISAM](http://dev.mysql.com/doc/refman/5.7/en/myisam-storage-engine.html), [Aria](https://mariadb.com/kb/en/mariadb/aria/), ...
You can find more details on these indicators here: You can find more details on these indicators here:
[Indicators description](https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md). [Indicators description](https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md).
@ -22,12 +22,12 @@ You can find more details on these indicators here:
MySQLTuner needs you: MySQLTuner needs you:
=== ===
**MySQLTuner** needs contributors for documentation, code and feedbacks.. **MySQLTuner** needs contributors for documentation, code and feedback..
* Please join us on issue track at [GitHub tracker](https://github.com/major/MySQLTuner-perl/issues). * Please join us on issue track at [GitHub tracker](https://github.com/major/MySQLTuner-perl/issues).
* Contribution guide is available following [MySQLTuner contributing guide](https://github.com/major/MySQLTuner-perl/blob/master/CONTRIBUTING.md) * Contribution guide is available 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)
Compatibility: Compatibility:
==== ====
@ -43,29 +43,29 @@ Compatibility:
* 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 vulnerabilities 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.**
Security recommandations Security recommendations
-- --
Hi directadmin user! 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! 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](https://github.com/major/MySQLTuner-perl/issues/289). Read link for more details [Issue #289](https://github.com/major/MySQLTuner-perl/issues/289).
What MySQLTuner is checking exactly ? 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.
@ -78,7 +78,7 @@ You can download the entire repository by using 'git clone' followed by the clon
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
@ -86,17 +86,17 @@ 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 --pass admin_password perl mysqltuner.pl --host targetDNS_IP --user admin_user --pass 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 --verbose perl mysqltuner.pl --verbose
perl mysqltuner.pl --buffers --dbstat --idxstat --sysstat --pfstat perl mysqltuner.pl --buffers --dbstat --idxstat --sysstat --pfstat
__Usage:__ Enable CVE vulnerabilities check for your MariaDB or MySQL version __Usage:__ Enable CVE vulnerabilities check for your MariaDB or MySQL version
@ -106,7 +106,7 @@ __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
@ -114,7 +114,7 @@ __Usage:__ Using template model to customize your reporting file based on [Text:
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
@ -123,7 +123,7 @@ 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 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?** **Question: Can I fire my DBA now?**
@ -136,7 +136,7 @@ The script will try its best to log in via any means possible. It will check fo
[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 ?**
@ -147,7 +147,7 @@ You could use mysql_config_editor utilities.
Enter passord: ******** Enter passord: ********
$ $
At this time, ~/.mylogin.cnf has been written with appropriated rigth access. After which, ~/.mylogin.cnf will be created with the appropriate access.
To get information about stored credentials, use the following command: To get information about stored credentials, use the following command:
@ -187,9 +187,9 @@ Connection and Authentication
--host <hostname> Connect to a remote host to perform tests (default: localhost) --host <hostname> Connect to a remote host to perform tests (default: localhost)
--socket <socket> Use a different socket for a local connection --socket <socket> Use a different socket for a local connection
--port <port> Port to use for connection (default: 3306) --port <port> Port to use for connection (default: 3306)
--user <username> Username to use for authentication --user <username> Username to use for authentication
--pass <password> Password to use for authentication --pass <password> Password to use for authentication
--defaults-file <path> defaulfs file for credentials --defaults-file <path> defaults file for credentials
Since you are using a remote host, use parameters to supply values from the OS Since you are using a remote host, use parameters to supply values from the OS
@ -214,8 +214,8 @@ MySQLTuner and Vagrant
* Fedora Core 23 / MariaDB 10.1 * Fedora Core 23 / MariaDB 10.1
* Fedora Core 23 / MySQL 5.6 * Fedora Core 23 / MySQL 5.6
* Fedora Core 23 / MySQL 5.7 * Fedora Core 23 / MySQL 5.7
**Vagrant File** are stored in Vagrant subdirectory. **Vagrant File** are stored in Vagrant subdirectory.
* Follow this 2 steps after vagrant installation: * Follow this 2 steps after vagrant installation:
* Rename VagrantFile_for_Mxxx into Vagrantfile * Rename VagrantFile_for_Mxxx into Vagrantfile
* vagrant up * vagrant up
@ -240,9 +240,8 @@ MySQLTuner and Vagrant
MySQLTuner needs you MySQLTuner needs you
-- --
**MySQLTuner** needs contributors for documentation, code and feedbacks.. **MySQLTuner** needs contributors for documentation, code and feedback..
* Please join us on issue track at [GitHub tracker](https://github.com/major/MySQLTuner-perl/issues). * Please join us on issue track at [GitHub tracker](https://github.com/major/MySQLTuner-perl/issues).
* Contribution guide is avalaible following [MySQLTuner contributing guide](https://github.com/major/MySQLTuner-perl/blob/master/CONTRIBUTING.md) * Contribution guide is available 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)