Help Center/ Migration Center/ Tool Guide/ Tool Discovery/ Configuring Collector Parameters/ MySQL-JDBC Collector (app-discovery-mysql-jdbc)
Updated on 2024-12-13 GMT+08:00
View PDF
Share

MySQL-JDBC Collector (app-discovery-mysql-jdbc)

This collector collects the host and port information of clients connected to a MySQL database by accessing the process list table of the MySQL database through JDBC. For details about the configuration parameters, see Table 1.

Table 1 Parameters for configuring the MySQL-JDBC collector

Parameter

Mandatory

Configuration

output_path

No

Enter the storage path of the collection result file (app-discovery-mysql-jdbc-xxx.csv). If this parameter is left blank, the storage path defaults to <collector-installation-path>\output\file.

Example: C:\Edge\tools\plugins\collectors\app-discovery-collectors\python\mgc-app-discovery-collectors\app-discovery-mysql-jdbc\output\file\app-discovery-mysql-jdbc-xxx.csv

ssl

No

If the SSL connection using the CA certificate fails, enter the SSL parameters supported by PyMySQL for login in format of Parameter name 1,Parameter value 1,Parameter name 2,Parameter value 2. For details about the parameters, see Table 2.

Example: ca,/data/ca.pem,key,/data/client-key.pem,cert,/data/client-cert.pem,check_hostname,True

ca

No

If the SSL CA authentication is enabled, set this parameter to the path where the CA certificate is stored.

In Linux, the default location of MySQL certificates depends on the MySQL installation mode and version. Generally, MySQL certificates are stored in the following directories:

  • MySQL 5.6 or earlier: /etc/mysql/
  • MySQL 5.7 or later: /var/lib/mysql/

For cloud databases, see the database documentation provided by the cloud vendors.

exclude_ip

No

Enter the IP addresses of the clients whose data does not need to be collected. Use commas (,) to separate multiple IP addresses. Example: 127.0.0.1,192.168.1.1

password

Yes

Enter the login password.

user

Yes

Enter the name of the user who has the PROCESS permissions.

To check the permissions of your MySQL account, perform the following steps:

Run the following command in the database and check whether PROCESS is set to Y:

SELECT * FROM mysql.user

port

Yes

Enter the port used to connect to and communicate with the MySQL server, for example, 3306.

endpoint

Yes

Enter the IP address of the MySQL server, for example, 192.168.1.100.
Table 2 PyMySQL SSL parameters

Parameter

Mandatory

Description

disabled

No

The default value is False. If this parameter is set to True, SSL is disabled. If no certificate is specified, this parameter does not take effect.

ca

Yes

Path of the CA certificate file

cert

Yes

Path of the client certificate file

key

Yes

Path of the client private key file

cipher

No

Encryption algorithm to be used

check_hostname

No

If this parameter is set to True, the hostname of the database server is verified during SSL connections. If no certificate is specified, this parameter does not take effect.