Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Settings

  • System Metrics
  • Data Collection
  • Replication
  • Galera
  • MySQL Error Log
  • MySQL Query Log
  • Audit Log
  • Sniffer
  • Deadlock
  • Monitors
  • Real-Time
  • Connection

Anchor
metrics
metrics
System Metrics (applicable for Linux based systems)

In the event that you would like SQL DM for MySQL to use SSH when communicating with this server, you can configure it from this tab. SQL DM for MySQL disables SSH communications by default. In order to use it, you need to click the Enable System Metrics switch. Doing so provides a series of configuration options needed to enable SSH on the server.

...

  • SSH Host: Host of the machine on which SSH server is running.
  • SSH Port: Port on which SSH server is listening. By default, it is 22.
  • SSH Username: Username to access the SSH server (Note: not the MySQL server).
  • Authentication type: Specify the type of authentication to use. This can be either key based or password based.
  • If you have specified Authentication type as Password - Provide the password.
  • If you have specified, Authentication type as Key - You should note that SQL DM for MySQL only supports ''OpenSSH standard key format'' for key based authentication in SSH connections.
    • Private Key: Paste the content of your private key file. Again, do not specify the path to your private key file.
    • Passphrase: Enter the passphrase for your private key file (if any). This can be left blank, if no passphrase was given for the private key.

Anchor
DataCollection
DataCollection
Data collection options

If you want to collect data from the server, you need to select "Enable Data Collection", so SQL DM for MySQL collects and stores various MySQL and OS metrics.

...

Also, note that if the 'base time' is smaller than uptime (or uptime_since_flush_status if available), then 'base time' setting is ignored. Using a 'base time' larger than 'uptime' and/or uptime_since_flush_status, then base time is considered. If a base time is in future, then most recent collection time is considered (similar to Delta).

Anchor
Replication
Replication
Replication Settings

SQL DM for MySQL monitors MySQL replicas by issuing a SHOW SLAVE STATUS on the slaves. SQL DM for MySQL can also auto-register slaves, given the master details.

...

How does SQL DM for MySQL auto-register all slaves of a given master? SQL DM for MySQL shoots a SHOW FULL PROCESSLIST on the master, and checks for all the slaves connected. (It assumes that MySQL and the SSH details of the slaves are the same as that of the master.) To view replication topology click the Replication tab.

Anchor
Galera
Galera
Galera

Use this option to Auto register all the Galera nodes of your cluster with SQL DM for MySQL. The MySQL and the SSH details of the nodes are assumed to be the same as that of the node on which you are enabling this option. In case the other node details are different from that of the node on which you are enabling this option, you need to manually edit that server, and change details. You can do a Test to check if SQL DM for MySQL is able to connect to the other nodes. If the Test gives a successful message then you can go ahead and click Save. SQL DM for MySQL registers the detected nodes and redirects you to the Servers page where you can see all the registered nodes.

Anchor
MySQLError
MySQLError
MySQL error log settings

The MySQL error log is quintessential in determining the health of the server. You can Enable error log monitoring to allow SQL DM for MySQL to keep an eye on your MySQL Error Log, and notify you of important information. 

...

Click this button to check if SQL DM for MySQL can access the file specified in the File path.

Anchor
MySQLQuery
MySQLQuery
MySQL query log settings

SQL DM for MySQL retrieves (completely or partially) the General query log and the Slow query log from the MySQL servers it connects to, and analyzes them. Here, we see how to set up details for the connection, so that log analysis is available with SQL DM for MySQL. You have to set up details for the general query log and the slow query log independently. Enabling Slow Query Log 'log queries not using indexes' instead needs SUPER privilege. Refer to the MySQL documentation on how to enable and configure logging. MySQL server logs can be written to files on the server machine or to tables in the MySQL database itself.

...

This option is supported by MySQL from version 5.1. Also, SQL DM for MySQL supports when this option is available. Here, you click the Fetch Log Details From MySQL button. When this option is used there is no file path to configure and no SSH details to consider. SQL DM for MySQL can retrieve the server log by sending simple SELECT statements. Only the MySQL user used by SQL DM for MySQL to connect to MySQL must have SELECT privileges to the tables.

Anchor
AuditLog
AuditLog
Audit Log Settings

This works exactly the same way as the MySQL Error log and MySQL Query Log. On enabling audit log monitoring, SQL DM for MySQL fetches the path from the server and displays it in the File Path box. Note that, we get the path from the variable "server_audit_file_path", and by default it just returns the audit log file name. In such cases, you have to manually enter the path for the audit log (by default, the path is same as datadir path).

Next, depending on where you have the MySQL server running, select an appropriate option for Read File From. If the server is on the same machine as SQL DM for MySQL, choose Local path. If it is on a remote machine, choose Via SFTP and give the corresponding SSH details. If the server is a RDS/Aurora server, then choose RDS/Aurora (Using API).

Anchor
Sniffer
Sniffer
Sniffer Settings

SQL DM for MySQL query sniffer is a functionality that records a pseudo server log and stores it in the SQL DM for MySQL embedded database. With Sniffer enabled, SQL DM for MySQL can populate the pseudo server log in three different ways at the intervals you specify:

...

You should note that the query sniffer is not a complete 'general log'. Very fast statements may or may not be recorded as they may or may not finish executing between two PROCESSLISTs generated. The time interval between subsequent data collections for the 'pseudo log' depends on the connection to the MySQL server.

Anchor
Deadlock
Deadlock
Deadlock settings

In transactional databases deadlocks are a classic problem, but these deadlocks are not too dangerous unless they are so frequent that you cannot run certain transactions at all. To trace the deadlocks reported by INNODB STATUS, you can select the toggle switch to "Enable deadlock monitoring" option.

Anchor
Monitors
Monitors
Monitors Settings

SQL DM for MySQL provides a way of disabling an entire group of Monitors. For instance if a MySQL server is not a replication slave, then the replication group can be disabled.

Anchor
Realtime
Realtime
Real-time

SQL DM for MySQL provides you the option to choose the data collection mode for Real-time monitoring. Here, you can choose between Processlist and Performance schema. You can choose the Performance schema mode if your MySQL version is 5.6.14 or above and if performance schema is enabled, otherwise you can go with Processlist mode.

Anchor
Connection
Connection
Connection Settings

You can specify the MySQL Connection Timeout value for your server. This option simply means that SQL DM for MySQL waits for this long to get a response from the server before it throws an error. This comes handy to avoid false positives when connection to some specific servers is slow. You can setup a larger timeout in such cases. If you have SSH Tunneling enabled to the MySQL then you can specify a SSH Tunnel Connection Timeout, and a SSH System Connection Timeout if System Metrics is enabled. The default value for all being 30 seconds.

...