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

Add user information to MySQL Python module documentation #7128

Merged
merged 6 commits into from Oct 24, 2019
Merged

Add user information to MySQL Python module documentation #7128

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
77f658b
add user details to MySQL py module doc
prhomhyse Oct 18, 2019
5849814
Update collectors/python.d.plugin/mysql/README.md
prhomhyse Oct 18, 2019
50ed241
Grammar fixes
prhomhyse Oct 18, 2019
2d7ea39
suggested changes
prhomhyse Oct 18, 2019
f3a9599
suggested changes
prhomhyse Oct 18, 2019
463de8c
add mysql shell
prhomhyse Oct 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 19 additions & 4 deletions collectors/python.d.plugin/mysql/README.md
View file
Open in desktop
Expand Up @@ -5,8 +5,19 @@ Module monitors one or more mysql servers
**Requirements:**

- python library [MySQLdb](https://github.com/PyMySQL/mysqlclient-python) (faster) or [PyMySQL](https://github.com/PyMySQL/PyMySQL) (slower)
- `netdata` local user to connect to the MySQL server.

It will produce following charts (if data is available):
To create the `netdata` user, execute the following in the MySQL shell:

```sh
create user 'netdata'@'localhost';
grant usage on *.* to 'netdata'@'localhost';
flush privileges;
```
The `netdata` user will have the ability to connect to the MySQL server on `localhost` without a password.
It will only be able to gather MySQL statistics without being able to alter or affect MySQL operations in any way.

This module will produce following charts (if data is available):

1. **Bandwidth** in kilobits/s

Expand Down Expand Up @@ -331,7 +342,8 @@ You can provide, per server, the following:

- key: the path name of the client private key file.
- cert: the path name of the client public key certificate file.
- ca: the path name of the Certificate Authority (CA) certificate file. This option, if used, must specify the same certificate used by the server.
- ca: the path name of the Certificate Authority (CA) certificate file. This option, if used, must specify the
same certificate used by the server.
- capath: the path name of the directory that contains trusted SSL CA certificate files.
- cipher: the list of permitted ciphers for SSL encryption.

Expand All @@ -358,9 +370,12 @@ remote:
port : 9000
```

If no configuration is given, module will attempt to connect to mysql server via unix socket at `/var/run/mysqld/mysqld.sock` without password and with username `root`
If no configuration is given, the module will attempt to connect to MySQL server via a unix socket at
`/var/run/mysqld/mysqld.sock` without password and with username `root`.

`userstats` graph works only if you enable such plugin in MariaDB server and set proper mysql priviliges (SUPER or PROCESS). For more detail please check [MariaDB User Statistics page](https://mariadb.com/kb/en/library/user-statistics/)
`userstats` graph works only if you enable the plugin in MariaDB server and set proper MySQL privileges (SUPER or
PROCESS). For more details, please check the [MariaDB User Statistics
page](https://mariadb.com/kb/en/library/user-statistics/)

---

Expand Down