Please enter a valid email address. The download links will be emailed to you.
The download links for
MONyog have been sent to
Back to Topics

Notification & Maintenance

The options here offer you to configure multiple notification channels. To route the alerts generated in Monyog, you will have to enable and configure the required channels.

image

Notification Subject Format

This section provides details to customize the Subject format of the alert notifications that you receive from Monyog. The default format is : MONyog | [$ALERT_TYPE] | [$SERVER_NAME] | [$MSG_DETAILS]

[$ALERT_TYPE] : This describes the severity of the alert - the values can be Critical, Warning, Stable and INFO. Alert type will be set based on the type of the alert for which the email was generated. The alert type will be set based on the below conditions:

  • Critical: Monyog will send critical alerts to the registered emails in a number of scenarios:

    1. When Monitor value crosses the set Critical threshold limit.
    2. When the Long running query action is “Notify And Kill.
    3. Low disk space alert.
      Eg: MONyog | Critical | Production | Excessive Privileges: Number Of Users Having Globa…
      MONyog | Critical | Monyog-Host | Low Disk Space.
  • Warning: Warning alerts are sent when it meets the following conditions:

    1. When Monitor value crosses the set Warning threshold limit.
    2. When the Long running action is “Notify”
      Eg: MONyog | Warning | 5.7.18 128 | MySQL Logs: General log - Enabled? - Yes.
  • Stable: When a Monitor value had crossed the set Critical/Warning threshold limits and is back to the recommended values, user will be notified that the alerting monitor is now stable. The Alert Type of this notication is Stable.
    Eg: MONyog | Stable | Staging | Current Connections: Currently running threads - 1.

  • Info: Alert type will be Info when the mysql server is restarts or there is a configuration change. This alert will be generated when the below conditions are enabled when the server was registered.

    1. Notify when server restarts.
    2. Notify when server config changed.
      Eg: MONyog | Info | Testing | Server configuration change detected.

[$SERVER_NAME] : Name of the server for which the alert is generated. Note, For Low disk space mails, the server_name is Monyog-Host.

[$MSG_DETAILS] : This specifies the details of the Alert.
For example, “Linux: CPU usage - 74.4%” OR “Long Running Query: QUERY” OR “Server configuration change detected" Or "Server restarted".
If there are more than one monitor alert in an email then this will list down the number of events in the email, i.e, “n Events” where ‘n’ is the “total no of events”.
Eg: MONyog | Critical | Production | 2 Events.

You can use the ‘Set Default’ option(the refresh button) to revert back to the default format.

Mail (SMTP)

Use this action to specify the SMTP server address and the "from" address of the e-mail sender.

  1. Click Settings -> Notification & Maintenance -> SMTP.The SMTP Server Settings window opens. Alternatively, you can click on the "Configure mail settings" link on the "Notifications Settings", when registering/editing a server's details, to arrive here.
  2. From: Type the from name and e-mail address with the name and address in the fields 'Your Name' and 'Your Email' respectively. This field must be in standard name@domain.com address format unless your relay server is set up to accept 'default domain' from addresses. Most problems involving configuration of the email alert are due primarily to an invalid email address format specified in the FROM/TO fields.
  3. Reply-to email: Enter email address of the recipient (or recipients) of the email message. This field must be in standard name@domain.com address format unless your relay server is prepared to accepted 'default domain' from addresses. Multiple Recipients:You may specify multiple recipients by simply separating the email addresses with a comma ",".

    Example: me@here.com, you@there.com, somebody@somewhere.com

  4. Type the SMTP server address. You can enter the host name, including domain, or the TCP/IP address. Example Gmail SMTP address is "smtp.gmail.com".

  5. Encryption: Select the type of Encryption - SSL/TLS mail encryption which is now supported for mail alerts.
  6. Port: This field signifies the TCP port on which host/ip addressshould connect in order to deliver the message. By default, this field is set to 25 (SMTP). However, some internal SMTP servers may be setup on non-standard ports which will require that this field be changed to match the listening port of the mail exchanger. For example Gmail listens to port 465 for SSL encryption and 587 for TLS encryption.
  7. Username and Password: When sending mail through an authenticated SMTP server, you can fill in the User and Password fields appropriately. If you are not using a secure SMTP server, an error 5xx unrecognized command may be returned from the server if you enter anything into one of these fields.

Note

Most problems involving configuration of the Email alert are due primarily to an invalid email address format specified in the FROM/TO fields. Please refer Registering servers for more information.

image

Note

For more information, see Automatic Email Notifications.

SNMP

Use this action to specify the SNMP settings and options available for use with Monyog.

Click Settings -> Notification & Maintenance -> SNMP to navigate to the SNMP settings page.

  • Version: Monyog supports 2 types of SNMP versions: SNMPv1 and SNMPV2c. You can select the trap type from this drop down.
  • Target: Type in the name or IP address of the host to which you want Monyog to direct traps.
  • Port: Enter the destination port here; by default, it is 162. This is the port where your SNMP Manager (or Client) will listen on for traps.
  • Community string: The read/write community string helps classify your SNMP operations. By default Monyog sets it to "public", but you can change to whatever suits your need.
  • Enable status traps: Status traps are sent when Monyog is starting up to indicate just that. If you want to be informed of when Monyog is starting up, select "Yes".
  • Use the remote MySQL Server host IP as the SNMP trap agent address for Monitor traps: Check this option if you want the sender IP of the traps sent by Monyog to be that of the host where the monitored MySQL server is running, instead of the host where Monyog is running. Note, that this only affects the Monitor traps sent by Monyog.

  • Clicking on Send Test Trap will send a status trap to the target and port specified, containing a string that indicates that this is a test trap.

  • To have your SNMP client decode the arcane digits identifying a trap, you need to load Monyog’s Management Information Base (MIB)s into your SNMP client. The MIB file is available in Monyog's installation directory. You can also download the file from the link provided in Monyog's browser interface.

image

Note more information on types of Traps:

  • Monitor Traps: Traps sent when one of the Monitors reaches an alert condition. Just like the notification emails, it will contain details about the faulting Monitor.

    Monitor traps are sent when the Send notifications over SNMP option is enabled, and the corresponding counters have mail alert enabled through the MOM.

  • Status Traps: Sent when Monyog starts up (if status traps are enabled) indicating just that, i.e. "Monyog is starting up". Also, clicking on Send Test Trap sends a status trap with the string "This is a test trap! If you see this message, you have correctly configured SNMP for Monyog."

PagerDuty

Click Settings -> Notification & Maintenance -> PAGERDUTY to navigate to the PagerDuty settings page.

PagerDuty integration allows you to route alerts to your PagerDuty service.

Use the integration key of the service that you want Monyog alerts to be sent to and select the type of alerts to be sent out. Click on “Test” button to verify whether the integration is configured successfully.

You can also create multiple routing rules based on the requirement for different servers registered with Monyog. To create a new rule select CREATE NEW RULE option in the drop down.

image

Note

Make sure that the integration key that you add has the integartion type as API.

Slack

Click Settings -> Notification & Maintenance -> SLACK to navigate to the SLACK settings page.

You can Integrate Slack to Monyog to receive the alerts and notifications from Monyog to your Slack channel.
Enter the name of the Channel that you want monyog alerts to be sent to in the SLACK CHANNEL field, enter the Incoming Webhook in the WEBHOOK URL field and Select the desired Alert Type. To ensure that the rule is configured successfully Test the rule by clicking the Test button. image

SYSLOG

Click Settings -> Notification & Maintenance -> SYSLOG to navigate to the SYSLOG settings page.

On enabling this option Monyog can write out the alerts and notifications to the Syslog(of the machine where Monyog is installed).

image

Note

This is applicable only for Linux installations.

Maintenance

Using this Maintenance option, you can enable/disable data collection from and/or alerting about all servers.

How To Change?

You can enable/disable data collection option and alert for all the registered server using Settings -> Notification & Maintenance -> Maintenance.

image