Monitoring

Introduction

Manage email/SMS notifications.

Iguana supports a rich error notification system that can send both email and SMS messages and log notification activity.

From here you can:

  • Enable/disable notifications, in the Status tab
  • Manage Email Server Settings
  • Manage Notification Rules

Enable/disable Notification [top]

From the Status tab you view or change the notification status.

  • Click Enable Email Notification to enable notifications
  • Click Disable Email Notification to disable notifications

Email Server Settings [top]

Use the Email Server Settings tab to configure the SMTP server that Iguana uses to send email notifications.

  • Update the settings and click Save Changes

Outgoing Mail Server

  • Enter the SMTP server that Iguana will to use to send notification emails

Mail Server Port

  • Enter port number used by the email server. The default value is 25 (used by many email servers).
  • In Iguana 6.1.1 and newer, you can use an environment variable in this field, just like the sender email address field.

Authentication

  • Enable Authentication if your SMTP server requires that you log in before sending messages:

    Warning: Gmail have updated login security for applications – you will need to generate an app password (instead of using the regular user password)

Sender Email Address

  • Enter the email address for sending the notification emails
  • To include an Environment Variable in the Email Address, use ${variable name}
    The Email Address will be previewed like this:

Iguana Host Name for Email Links

  • Enter the base URL for links included in notification emails
  • To use the server host name, click the Current host name (recommended) link:
  • You may include a port number (i.e., myhost:80), if you omit the port number the Iguana Web Server Port is used
    for example: 192.168.1.2 generates: http://192.168.1.2:6543/<remainder of link> (using default port 6543)
  • If you set your Web Server Port to use HTTPS then you will need to prefix the URL with “https://”
    for example https://192.168.1.2 generates: https://192.168.1.2:6543/<remainder of link> (using default port 6543)

Warning! The Iguana Host Name for Email Links field is the IP Address for the server machine used to send email notifications. If this IP address changes, the email links will no longer work. Ideally, you should assign this field a static IP or use DNS resolution (talk to your network guy).

Many ISPs assign IP addresses dynamically (DHCP) which means the address will eventually change (when the DHCP lease expires). Mobile internet connections also change their IP addresses very frequently.

Validation Email [top]

After adding/changing Email Server Settings you will need to validate your email.

  • Click Send Validation Email
  • Select the email recipient and click Send Validation Email
  • Click on the Validation Link in the confirmation email, and log in to Iguana to validate your email settings:

If you have problems with your connection, the SMTP log can be helpful:

Notification rules [top]

From this tab you manage notification rules.

From here you can, manage Standard Rules to monitor for specific errors in the logs, manage Channel Inactivity Rules to monitor server activity.

Note: You can also create a notification rule without a Recipient and monitor it in the logs, see log entries generated for notifications.

  • Click Edit to modify or Add a Rule to create a new rule
  • When adding a rule choose the Rule Type
  • Enter the desired settings and click Save Changes

Standard Notification Rules [top]

Standard rules are the most flexible, they are triggered by log messages that match a pattern defined in the rule.

  • Click Edit to modify or Add a Rule to create a new rule
  • When adding a rule check the Standard Rule Rule Type
  • Enter the desired settings and click Save Changes

Source Type

  • All entries: Check against all log entries
  • Service Entries: Check log entries generated by the Iguana web service
  • Channel: Check against entries generated by the specified channel
  • Group: Check against entries generated by the specified group
  • For Source Type = Channel select a Channel to monitor
  • For Source Group = Group select a Channel Group to monitor

Type

  • Select the Type of log entry to monitor:

Text Query

  • Specify the text strings to match.
  • You can use strings with boolean logic and regular expressions
  • For example: We can look for log entries containing “ALERT” or “Warning – possible name conflict”

    Note: To trigger the alert you simply need to write channel code that logs messages containing the text query string

Limit of Messages Sent

  • Limit the number of notification messages sent per hour

Include Log Entry Text in Email Message

  • Choose whether to include the log entry text in the alert email
    Note: Only choose this option if you are sure there is no private information included in the log entry

Recipient

  • Choose the Users or Roles to email alerts to

Channel Inactivity Rules [top]

Channel inactivity rules are triggered when a channel has no transactions for a specified period of time.

  • Select Edit to modify or Add a Rule to create a new rule
  • When adding a rule check the Channel Inactivity Rule Rule Type
  • Enter the desired settings and click Save Changes

Source Type

  • Choose a Channel or a Channel Group
  • For Source Type = Channel select a Channel to monitor
  • For Source Type = Group select a Channel Group to monitor

Alert if Channel is Inactive For

  • Set the inactivity period in minutes or hours

Notification Schedule

  • Select when to send out alerts

Notify When Channel Activity Resumes

  • Choose whether to alert when activity resumes

Recipients

  • Choose the Users or Roles to email alerts to

Log entries generated for notifications [top]

When a notification is triggered it generates an Error like this in the log:

If an email or SMS message is also generated an error will be logged if a problem occurs.

For email:

For SMS:

Tagged: