Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merge doc #754

Merged
merged 3 commits into from
Feb 6, 2024
Merged

Merge doc #754

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c6bdbb
Updates README + # 747
jmrenouard Feb 6, 2024
c1d00b9
Format fixing
jmrenouard Feb 6, 2024
cf4e6b4
Adding informations about csv dump options
jmrenouard Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 65 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,21 @@ Compatibility

Test result are available here: [Travis CI/MySQLTuner-perl](https://travis-ci.org/major/MySQLTuner-perl)

* MySQL 8.0 (partial support, password checks don't work)
* Percona Server 8.0 (partial support, password checks don't work)
* MySQL 5.7 (full support)
* Percona Server 5.7 (full support)
* MariaDB 10.3 - 10.11 (full support)
* MySQL 8.0, 8.2, 8.3 (full support)
* Percona Server 8.0, 8.2, 8.3 (full support)
* MariaDB 10.4, 10.5, 10.6, 10.11, 11.0, 11.1, 11.2 (full support)
* Galera replication (full support)
* Percona XtraDB cluster (full support)
* Mysql Replications (partial support, no test environment)

* MySQL 8.1 (not supported, deprecated version)
* Percona Server 5.7 (not supported, deprecated version)
* MySQL 5.7 (not supported, deprecated version)
* MySQL 5.6 and earlier (not supported, deprecated version)
* Percona Server 5.6 (not supported, deprecated version)
* MariaDB 10.7, 10.8, 10.9, 10.10 (not supported, deprecated version)
* MariaDB 10.3 and earlier (not supported, deprecated version)
* MariaDB 5.5 (not supported, deprecated version)
* MariaDB 10.2 and earlier (not supported, deprecated version)

***Windows Support is partial***

Expand All @@ -65,17 +67,22 @@ Test result are available here: [Travis CI/MySQLTuner-perl](https://travis-ci.or
* Cloud based is not supported at this time (Help wanted! GCP, AWS, Azure support requested)

***Unsupported storage engines: PRs welcome***
--

* NDB is not supported feel free to create a Pull Request
* MyISAM is too old and no longer active
* RockDB
* Archive
* Spider
* ColummStore
* TokuDB
* XtraDB
* Connect

Unmaintenained staff from MySQL or MariaDB:
--

* MyISAM is too old and no longer active
* RockDB is not maintained anymore
* TokuDB is not maintained anymore
* XtraDB is not maintained anymore

* CVE vulnerabilities detection support from [https://cve.mitre.org](https://cve.mitre.org)

***MINIMAL REQUIREMENTS***
Expand Down Expand Up @@ -143,18 +150,40 @@ cd mysql-sys-master
mysql -uroot -p < sys_56.sql
```

Optional Performance schema and Sysschema installation for MariaDB < 10.6
Performance schema setup
--

Sysschema is not installed by default under MariaDB prior to 10.6 [MariaDB sys](https://mariadb.com/kb/en/sys-schema/)
By default, performance_schema is enabled and sysschema is installed on latest version.

By default, on MariaDB, performance schema is disabled by default (MariaDB<10.6).

By default, on MariaDB, performance schema is disabled by default. consider activating performance schema across your my.cnf configuration file:
Consider activating performance schema across your my.cnf configuration file:

```ini
[mysqld]
performance_schema = on
performance-schema-consumer-events-statements-history-long = ON
performance-schema-consumer-events-statements-history = ON
performance-schema-consumer-events-statements-current = ON
performance-schema-consumer-events-stages-current=ON
performance-schema-consumer-events-stages-history=ON
performance-schema-consumer-events-stages-history-long=ON
performance-schema-consumer-events-transactions-current=ON
performance-schema-consumer-events-transactions-history=ON
performance-schema-consumer-events-transactions-history-long=ON
performance-schema-consumer-events-waits-current=ON
performance-schema-consumer-events-waits-history=ON
performance-schema-consumer-events-waits-history-long=ON
performance-schema-instrument='%=ON'
max-digest-length=2048
performance-schema-max-digest-length=2018
```

Sysschema installation for MariaDB < 10.6
--

Sysschema is not installed by default under MariaDB prior to 10.6 [MariaDB sys](https://mariadb.com/kb/en/sys-schema/)

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

```bash
Expand All @@ -167,13 +196,27 @@ mysql -u root -p < ./sys_10.sql
```

Errors & solutions for performance schema installation
--


ERROR 1054 (42S22) at line 78 in file: './views/p_s/metrics_56.sql': Unknown column 'STATUS' in 'field list'
--


This error can be safely ignored
Consider using a recent MySQL/MariaDB version to avoid this kind of issue during sysschema installation

In recent versions, sysschema is installed and integrated by default as sys schema (SHOW DATABASES)



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
--

Fixing sysctl configuration (/etc/sysctl.conf)
--

--
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)

You can check its values via:
Expand Down Expand Up @@ -252,6 +295,14 @@ perl mysqltuner.pl --silent --reportfile /tmp/result_mysqltuner.txt --template=/

__Important__: [Text::Template](https://metacpan.org/pod/Text::Template) module is mandatory for `--reportfile` and/or `--template` options, because this module is needed to generate appropriate output based on a text template.


__Usage:__ Dumping all information_schema and sysschema views as csv file into results subdirectory

```bash
perl mysqltuner.pl --verbose --dumpdir=./result
```


__Usage:__ Enable debugging information

```bash
Expand Down