Page History
The SQL DM for MySQL API allows users to retrieve monitor and chart values programmatically. The API supports fetching current, delta, and historical data.
Base URL
http://127.0.0.1:5555/
Authentication
All API requests need authentication using the following parameters:
_user: It may be sqldm user, LDAP user or LDAP Group user. In case no user is supplied, admin account is used by default._password: The password for the specified _user.
API Endpoints
| UI Expand | |||||
|---|---|---|---|---|---|
| |||||
Description:Retrieves all enabled monitors' values. Endpoint:
Request Parameters:
Example Call:
|
| UI Expand | |||||
|---|---|---|---|---|---|
| |||||
Description:Fetches the value of a specific monitor. Endpoint:
Request Parameters:
Example Call:
|
| UI Expand | |||||
|---|---|---|---|---|---|
| |||||
Description:Retrieves trend values of a specific monitor over time. Endpoint:_ Request Parameters:
Example Call:
|
| UI Expand | |||||
|---|---|---|---|---|---|
| |||||
Description:Retrieves all chart values of a specific dashboard. Endpoint:
Request Parameters:
Example Call:
|
| UI Expand | |||||
|---|---|---|---|---|---|
| |||||
Description:Retrieves values of a specific chart. Endpoint:
Request Parameters:
Example Call:
|
Response Format
All API responses return JSON data.
Success Response:
{ "STATUS": "SUCCESS", "RESPONSE": [{ "GroupName": "xxxx", "CounterName": "xxxx", "Value": "Yes", "AlertStatus": "1", "AlertCondition": "None" }]}
Failure Response:
{ "STATUS": "FAILURE", "RESPONSE": "Error Message"}
Notes:
_typeis required for monitor queries._starttimeand_endtimeare needed for historical data and getting trend values.- Monitor
group_idandcounter_idare found on the Monitors page.
- Chart
group_idandcounter_idshould be displayed on mouse hover in the UI.
SSH tunneling for MySQL
...
Property name
...
Description
...
_sshhost
...
Host machine on which SSH server is running.
...
_sshuser
...
Username to access the SSH server.
...
_sshport
...
Port on which SSH server is listening.
Range: 1 .. 65535
Defaluts: "22"
...
_sshauthtype
...
SSH authentication type.
Permitted values: key,password
Default: password
...
_sshpassword
...
SSH user's password for password based authentication.
...
_sshprivatekey
...
SSH user's private 'key' for key based authentication.
Note The key must be url encoded. For example line endings \r\n must be encoded to %0A and " " (white space) to +.
...
_sshpassphrase
...
Passphrase for private key file (if any) for key based authentication.
SSL encryption for MySQL
...
Property name
...
Description
...
_cacertificate
...
The digital certificate issued by CA.
Note The key must be url encoded. For example line endings 'rn' must be encoded to '%0A' and " " (white space) to "+".
...
_sslcipher
...
Encryption algorithm like DES, AES etc.
Note The key must be url encoded. For example line endings 'rn' must be encoded to '%0A' and " " (white space) to "+".
...
_usesslauth
...
SSL client authentication type.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_clientkey
...
Private key of the client that is needed for encryption.
...
_clientcertificate
...
The client certificate.
SSH settings
To enable and use SSH for reading logs via SFTP and/or OS monitoring, the following query parameters are required:
...
Property name
...
Description
...
_osmonitoring
...
Enable or disable SSH settings for OS monitoring/reading MySQL logs via SFTP.
Permitted values: yes/no; true,false;1/0
Default: no
...
_ostype
...
OS monitoring is available for Linux systems only. Setting to "Linux", SQL DM for MySQL can monitor system related metrics like CPU consumption, Memory Usage, etc.
Permitted values: linux,rds
.
...
_ossameasmysqltunnel
...
Uses the same SSH details provided for SSH tunneling. Setting to "yes" will use the details provided for SSH tunneling to MySQL for this registration.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_sshsystemhost
...
Host machine on which SSH server is running.
...
_sshsystemuser
...
Username to access the SSH server.
...
_sshsystemport
...
Port on which SSH server is listening.
Range: 1 ..65535
Default: "22"
...
_sshsystemauthtype
...
SSH authentication type to be used.
...
_sshsystempassword
...
SSH user's password for password based authentication.
...
_sshsystemprivatekey
...
SSH user's private 'key' for key based authentication.
Note The key must be url encoded. For example line endings 'rn' must be encoded to '%0A' and " " (white space) to "+".
...
_sshsystempassphrase
...
Passphrase for your private key file (if any) for 'key' based authentication.
Notification settings
...
Property name
...
Description
...
_mailalerts
...
Setting to "yes" will send alerts/notifications via email.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_snmpalerts
...
Setting to "yes" will trigger SNMP traps on event of alerts.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_mailaddress
...
SQL DM for MySQL will send alerts to the email addresses specified under _mailaddress. Accepts comma (,) separated list of email addresses.
...
_mailaddresscritical
...
SQL DM for MySQL will send critical alerts to the email addresses specified under _mailaddresscritical.
...
_mailaddresswarning
...
SQL DM for MySQL will send warning alerts to the email addresses specified under _mailaddresswarning
...
_mailaddressother
...
SQL DM for MySQL will send other alerts such as MySQL server restart and MySQL configuration changes to the email addresses specified under _mailaddressother.
...
_writetosyslog
...
Seting to yes will route the alert notifications to syslog.
Permitted values: yes/no; true,false; 1/0
...
_slackalerts
...
Setting to "yes" will route alerts/notifications to the Slack room.
Permitted values: yes/no
...
_slackrulename
...
Specify the Slack Rule to be used.
...
_pagerdutyalerts
...
Setting to "yes" will route alerts/notifications to the PagerDuty.
Permitted values: yes/no
...
_pagerdutyrulename
...
Specify the PagerDuty rule to be used.
...
_alertableinterval
...
Number of times to wait before sending the alerts.
Default: "1"
...
_notifyserverconfigchange
...
SQL DM for MySQL will send an alert whenever there is a change in MySQL configuration.
Permitted values: yes/no; true,false; 1/0
Default: "yes"
...
_notifyserverrestart
...
SQL DM for MySQL will send an alert whenever the server restarts.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_briefemail
...
Enable or disable detailed email notification.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_notifystable
...
Notify stable alerts when monitor goes into alert-able state and then becomes stable.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_notifytillstable
...
Keeps notifying the user until the counter becomes stable.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_reminderinterval
...
Defines the number of data collections after which the user receives the notification until the counter becomes stable.
Default: "5"
Data collection settings
...
Property name
...
Description
...
_datacollection
...
Enable data collection for server. SQL DM for MySQL will not collect data for this registration if data collection is disabled.
Permitted values: yes/no; true,false; 1/0
Default: "yes"
...
_datacollectioninterval
...
The interval for the data collections in seconds.
Default: "300" seconds (5 minutes)
...
_dataretentiontime
...
Data purging interval for the server. Timeframe should be specified in seconds.
Default: "604800" (7 days)
Replication settings
...
Property name
...
Description
...
_replicationslave
...
Consider a server as slave server.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_autoregisterslaves
...
Register all slave servers.
Permitted values: yes/no; true,false; 1/0
Default: "no"
Galera Settings
...
Property name
...
Description
...
_autoregistergaleranodes
...
Auto-register all galera nodes.
Permitted values: yes/no; true,false; 1/0
Default: "no"
Error log monitoring
...
Property name
...
Description
...
_enableerrorlog
...
To enable error log monitoring.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_errorlogreadmode
...
Mode to read the error log file.
Permitted values: sftp, local, rds
Default: "local"
...
_errorlogpath
...
MySQL error log path.
Default: "/var/log/mysql/server-err.log"
...
_dbidentifier
...
A unique name to identify your RDS/Aurora instance.
...
_instanceregion
...
The region in which your instance is hosted, e.g: us-east-1.
...
_accesskey
...
A 20 character long key ID, is generated from AWS Mangement Console.
...
_secretkey
...
A 40 character long key ID, is generated from AWS Management Console.
Slow query log and General query log settings
...
Property name
...
Description
...
_logreadmode
...
Mode to read the General and Slow query log files.
Permitted values: sftp, local, rds
Default: "local"
...
_querylogdestination
...
Read logs stored either from FILE or TABLE.
Permitted values: file, table
Default: "file"
...
_enableslowquery
...
To enable slow query log monitoring.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_slowquerylogpath
...
Path for slow log.
Default: /var/log/mysql/server-slow.log
...
_enablegeneralquery
...
To enable general query log monitoring.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_generalquerylogpath
...
Path for general log.
Default: /var/log/mysql/server-general.log
...
_dbidentifier
...
A unique name to identify your RDS/Aurora instance.
...
_instanceregion
...
The region in which your instance is hosted, e.g: us-east-1.
...
_accesskey
...
A 20 character long key ID, is generated from AWS Management Console.
...
_secretkey
...
A 40 character long key ID, is generated from AWS Management Console.
Audit log settings
...
Property name
...
Description
...
_auditlogreadmode
...
Mode to read Audit log.
Permitted values: sftp, local, rds
Default: "local"
...
_enableauditlog
...
To enable audit log monitoring.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_auditlogpath
...
Path for audit log.
Default: /var/lib/mysql/server_audit.log
...
_dbidentifier
...
A unique name to identify your RDS/Aurora instance.
...
_instanceregion
...
The region in which your instance is hosted, e.g: us-east-1.
...
_accesskey
...
A 20 character long key ID, is generated from AWS Management Console.
...
_secretkey
...
A 40 character long key ID, is generated from AWS Management Console.
Sniffer settings
...
Property name
...
Description
...
_enablesniffer
...
Enable or disable sniffer analysis.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_sniffermode
...
Specifying a way to populate sniffer data for analysis.
Permitted values: processlist, performanceschema, proxy
Default: "processlist"
...
_monitorlongrunningqueries
...
Monitor only long running queries, executing beyond the specified time.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_longrunningquerytime
...
The time which qualifies a query as long running query (in seconds).
Default: "10"
...
_ignorequeriesbyuser
...
A filter to ignore queries by a user.
...
_longrunningqueryaction
...
The action to be performed for long running queries.
Permitted values: notify, kill, notifyandkill
Default: notify
...
_monitorlockedqueries
...
Monitors for queries in the locked state.
Permitted values: yes/no; true,false; 1/0
Default: "no"
...
_snifferproxyhost
...
MySQL proxy host.
...
_snifferproxyport
...
MySQL proxy port.
...
_sniffinginterval
...
This interval specifies how frequently SQL DM for MySQL should "sniff" MySQL server (in seconds).
Default: "1"
...
_snifferpurginginterval
...
Specifying a timeframe to purge the data collected (in seconds).
Default: "259200" (3 days)
...
_snifferfilteruser
...
A filter to sniff queries only by specified users.
...
_snifferfilterhost
...
A filter to sniff queries only by specified hosts.
...
_sniffquerystartingwith
...
To sniff queries starting with the string.
...
_snifferlongquerymail
...
Setting to "yes" will enable SQL DM for MySQL to send mail alerts for long running queries.
Permitted values: yes/no
...
_snifferlongquerymailto
...
SQL DM for MySQL will send long running query alert to the email addresses specified under _snifferlongquerymailto
...
_snifferlongquerytrap
...
Setting to "yes" will enable SQL DM for MySQL to send SNMP traps for the long running queries.
Permitted values: yes/no
...
_snifferlongquerywritetosyslog
...
Setting to "yes" will enable SQL DM for MySQL to write the alerts for the long running queries to the syslog of the host machine of SQL DM for MySQL.
Permitted values: yes/no
...
_snifferlongqueryslack
...
Setting to "yes" will enable SQL DM for MySQL to route the alerts to the Slack room for the long running queries.
Permitted values: yes/no
...
_snifferlongqueryslackrule
...
Specify the Slack rule to be used for sending the Long running query alerts.
...
_snifferlongquerypagerduty
...
Setting to "yes" will enable SQL DM for MySQL to route the alerts to PagerDuty for the long running queries.
Permitted values: yes/no
...
_snifferlongquerypagerdutyrule
...
Specify the PagerDuty rule to be used for sending the Long running query alerts.
Deadlock monitoring settings
...
Property name
...
Description
...
_enabledeadlockmonitoring
...
Enable or disable InnoDB deadlock monitoring. Turning this ON will help in tracing deadlocks reported by "SHOW INNODB STATUS".
Permitted values: yes/no; true,false; 1/0
Default: "no"
Manage Monitors settings
...
Property name
...
Description
...
_disabledmonitorgroups
...
This specifies the monitor groups that are to be disabled for the server. Comma-separated Group IDs may be supplied. To know the Group IDs of the various monitor groups, you may hover over the Monitor Groups in Customize -> Manage Monitor Groups. For example, if you want to disable, Binary Log (Group ID: 17), Replication (Group ID : 19) and MySQL Cluster(Group ID: 27), the parameters will be 17,19,27
Default: 7,14,22
Real-Time Mode Setting
...
Property name
...
Description
...
_realtimemode
...
For setting up Real-Time monitoring mode.
Permitted values: processlist/performanceschema
Default: "processlist"
Connection Settings
...
Property name
...
Description
...
_mysqlconnecttimeout
...
Specify MySQL connection timeout.
Default: "30" seconds
...
_sshconnecttimeout
...
Specify SSH tunnel connection timeout.
Default: "30" seconds
...
_sshsystemconnecttimeout
...
Specify SSH connection timeout.
Default: "30" seconds
...
| Newtabfooter | ||||
|---|---|---|---|---|
|
...
| Newtabfooter | ||||
|---|---|---|---|---|
|
...
| Newtabfooter | ||||
|---|---|---|---|---|
|
...
| Newtabfooter | ||||
|---|---|---|---|---|
|
...
| Newtabfooter | ||||
|---|---|---|---|---|
|
...
| Newtabfooter | ||||
|---|---|---|---|---|
|
...
| Newtabfooter | ||||
|---|---|---|---|---|
|
...