Skip to content

Commit fa6fdfb

Browse files
authored
Merge pull request #704 from longradix/master
Update README.md
2 parents 3159e13 + 15bd21a commit fa6fdfb

File tree

1 file changed

+27
-39
lines changed

1 file changed

+27
-39
lines changed

README.md

Lines changed: 27 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
[![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")
99
[![GPL License](https://badges.frapsoft.com/os/gpl/gpl.png?v=103)](https://opensource.org/licenses/GPL-3.0/)
1010

11-
**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.
11+
**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.
1212

13-
**MySQLTuner** supports ~300 indicators for MySQL/MariaDB/Percona Server in this last version.
13+
**MySQLTuner** supports ~300 indicators for MySQL/MariaDB/Percona Server in this latest version.
1414

15-
**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/), ...
15+
**MySQLTuner** is actively maintained supporting many configurations 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/), ...
1616

1717
You can find more details on these indicators here:
1818
[Indicators description](https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md).
@@ -24,7 +24,7 @@ MySQLTuner needs you
2424

2525
**MySQLTuner** needs contributors for documentation, code and feedback:
2626

27-
* Please join us on issue track at [GitHub tracker](https://github.com/major/MySQLTuner-perl/issues).
27+
* Please join us on our issue tracker at [GitHub tracker](https://github.com/major/MySQLTuner-perl/issues).
2828
* Contribution guide is available following [MySQLTuner contributing guide](https://github.com/major/MySQLTuner-perl/blob/master/CONTRIBUTING.md)
2929
* Star **MySQLTuner project** at [MySQLTuner Git Hub Project](https://github.com/major/MySQLTuner-perl)
3030
* Paid support for LightPath here: [[email protected]]([email protected])
@@ -45,41 +45,29 @@ Test result are available here: [Travis CI/MySQLTuner-perl](https://travis-ci.or
4545
* Percona Server 8.0 (partial support, password checks don't work)
4646
* MySQL 5.7 (full support)
4747
* Percona Server 5.7 (full support)
48-
* MariaDB 10.11 (full support)
49-
* MariaDB 10.10 (full support)
50-
* MariaDB 10.9 (full support)
51-
* MariaDB 10.8 (full support)
52-
* MariaDB 10.7 (full support)
53-
* MariaDB 10.6 (full support)
54-
* MariaDB 10.5 (full support)
55-
* MariaDB 10.4 (full support)
56-
* MariaDB 10.3 (full support)
48+
* MariaDB 10.3 - 10.11 (full support)
5749
* Galera replication (full support)
5850
* Percona XtraDB cluster (full support)
5951
* Mysql Replications (partial support, no test environment)
6052

61-
* MySQL 5.6 (no support, deprecated version)
62-
* Percona Server 5.6 (no support, deprecated version)
63-
* MySQL 5.5 (no support, deprecated version)
64-
* MariaDB 5.5 (no support, deprecated version)
65-
* MariaDB 10.2 (no support, deprecated version)
66-
* MariaDB 10.1 (no support, deprecated version)
67-
* MariaDB 10.0 (no support, deprecated version)
68-
* MySQL 3.23, 4.0, 4.1, 5.0, 5.1 (no support - deprecated version)
53+
* MySQL 5.6 and earlier (not supported, deprecated version)
54+
* Percona Server 5.6 (not supported, deprecated version)
55+
* MariaDB 5.5 (not supported, deprecated version)
56+
* MariaDB 10.2 and earlier (not supported, deprecated version)
6957

7058
***Windows Support is partial***
7159

7260
* Windows is now supported at this time
73-
* Successfully run MySQLtuner across WSL2 (Windows Subsystem Linux )
61+
* Successfully run MySQLtuner across WSL2 (Windows Subsystem Linux)
7462
* [https://docs.microsoft.com/en-us/windows/wsl/](https://docs.microsoft.com/en-us/windows/wsl/)
7563

76-
***UNSUPPORTED ENVIRONMENTS - NEED HELP FOR THAT :)***
77-
* Cloud based is not supported at this time (Help wanted !!!!! GCP, AWS, Azure support asked)
64+
***UNSUPPORTED ENVIRONMENTS - NEED HELP WITH THAT***
65+
* Cloud based is not supported at this time (Help wanted! GCP, AWS, Azure support requested)
7866

7967
***Unsupported storage engines: PRs welcome***
8068

81-
* NDB is not supported feel free to Pull Request code :)
82-
* MyISAM is to old is no longer active
69+
* NDB is not supported feel free to create a Pull Request
70+
* MyISAM is too old and no longer active
8371
* RockDB
8472
* Archive
8573
* Spider
@@ -99,18 +87,18 @@ Test result are available here: [Travis CI/MySQLTuner-perl](https://travis-ci.or
9987
***WARNING***
10088
--
10189

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

110-
It's **also important** to wait at least a day of uptime to get accurate results. In fact, running
98+
It's **also important** to wait at least 24 hours of uptime to get accurate results. In fact, running
11199
**mysqltuner** on a fresh restarted server is completely useless.
112100

113-
**Seriously - please review the FAQ section below.**
101+
**Also review the FAQ section below.**
114102

115103
Security recommendations
116104
--
@@ -119,7 +107,7 @@ Hi directadmin user!
119107
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!
120108
Read link for more details [Issue #289](https://github.com/major/MySQLTuner-perl/issues/289).
121109

122-
What MySQLTuner is checking exactly ?
110+
What is MySQLTuner checking exactly ?
123111
--
124112

125113
All checks done by **MySQLTuner** are documented in [MySQLTuner Internals](https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md) documentation.
@@ -167,7 +155,7 @@ By default, on MariaDB, performance schema is disabled by default. consider acti
167155
performance_schema = on
168156
```
169157

170-
You can follow this command to create a new database sys containing very useful view on Performance schema:
158+
You can follow this command to create a new database sys containing a useful view on Performance schema:
171159

172160
```bash
173161
curl "https://codeload.github.com/FromDual/mariadb-sys/zip/master" > mariadb-sys.zip
@@ -186,7 +174,7 @@ Have a look at #452 solution given by @ericx
186174
Performance tips
187175
--
188176

189-
Metadata statistic updates can impact strongly performance of database servers and MySQLTuner.
177+
Metadata statistic updates can strongly impact performance of database servers.
190178
Be sure that innodb_stats_on_metadata is disabled.
191179

192180
```bash
@@ -196,7 +184,7 @@ set global innodb_stats_on_metadata = 0;
196184
Fixing sysctl configuration (/etc/sysctl.conf)
197185
--
198186

199-
It is a system wide setting: [Linux FS Kernel settings](https://www.kernel.org/doc/html/latest/admin-guide/sysctl/fs.html#id1)
187+
It is a system wide setting and not a database setting: [Linux FS Kernel settings](https://www.kernel.org/doc/html/latest/admin-guide/sysctl/fs.html#id1)
200188

201189
You can check its values via:
202190

@@ -227,11 +215,11 @@ __Usage:__ Minimal usage locally
227215
perl mysqltuner.pl --host 127.0.0.1
228216
```
229217

230-
Of course, you can add the execute bit (`chmod +x mysqltuner.pl`) so you can execute it without calling perl directly.
218+
Of course, you can add the execute bit (`chmod +x mysqltuner.pl`) so you can execute it without calling Perl directly.
231219

232220
__Usage:__ Minimal usage remotely
233221

234-
In previous version, --forcemem shoud be set manually, in order to be able to run an MT analysis
222+
In previous version, --forcemem shoud be set manually, in order to be able to run an MySQLTuner analysis
235223

236224
Since 2.1.10, memory and swap are defined to 1Gb by default.
237225

@@ -389,7 +377,7 @@ To optimize other database systems, you would need to use tools designed for tho
389377

390378
**Question: Does MySQL tuner support MariaDB and Percona Server ?**
391379

392-
Yes, MySQL tuner supports MariaDB and Percona Server since they are forks of MySQL and share a similar architecture. The script can analyze and provide recommendations for these systems as well.
380+
Yes, MySQL tuner supports MariaDB and Percona Server since they are derivatives of MySQL and share a similar architecture. The script can analyze and provide recommendations for these systems as well.
393381

394382
**Question: What should I do if I need help with MySQL tuner or have questions about the recommendations ?**
395383

@@ -399,7 +387,7 @@ Be cautious when implementing changes to ensure the stability and performance of
399387

400388
**Question: Will MySQLTuner fix my slow MySQL server ?**
401389

402-
**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.*
390+
**No.** MySQLTuner is a read only script. It won't write to any configuration files, change the status of any daemons. 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.
403391

404392
**Question: Can I fire my DBA now?**
405393

@@ -415,7 +403,7 @@ The script will try its best to log in via any means possible. It will check fo
415403
user=someusername
416404
password=thatuserspassword
417405

418-
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.
406+
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.
419407

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

0 commit comments

Comments
 (0)