Additional Parameters for API

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:

_cacertificate

The digital certificate issued by CA.

Note: The key must be url encoded. For example line endings '\r\n' 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 '\r\n' 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:

_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", Monyog can monitor system related metrics like CPU consumption, Memory Usage, etc.

 

Permitted values : linux, rds, azure, others

Default: "linux"

_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 '\r\n' must be encoded to '%0A' and " " (white space) to "+".

_sshsystempassphrase

Passphrase for your private key file (if any) for 'key' based authentication.


Notification settings:

_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

The address to which Monyog to send e-mails alerts to. Accepts comma (,) separated list of email addresses.

_alertableinterval

Number of times to wait before sending the alerts.

Default: "1"

_notifyserverconfigchange

Monyog will send an alert whenever there is a change in MySQL configuration.

Permitted values : yes/no; true,false; 1/0

Default: "yes"

_notifyserverrestart

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

_datacollection

Enable data collection for server. Monyog 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:

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


Error log monitoring:

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

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


Sniffer settings:

_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

_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 Monyog 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.


Deadlock monitoring settings:

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

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

_realtimemode

For setting up Real-Time monitoring mode.

Permitted values : processlist/performanceschema

Default: "processlist"

API Token Manager

Still need help? Contact Us Contact Us