docs.intersystems.com
Home  /  System Administration  /  Monitoring Guide  /  Using InterSystems IRIS Monitor


Monitoring Guide
Using InterSystems IRIS Monitor
[Back]  [Next] 
InterSystems: The power behind what matters   
Search:  


InterSystems IRIS™ Monitor monitors the InterSystems IRIS instance’s console log for errors and traps reported by InterSystems IRIS daemons and user processes and generates corresponding notifications, including email if configured. This chapter discusses the following topics:
InterSystems IRIS System Monitoring Tools
InterSystems IRIS provides three sets of tools for general monitoring of InterSystems IRIS instances, as follows:
InterSystems IRIS Monitor Overview
InterSystems IRIS Monitor scans the console log at regular intervals for entries of the configured severity level and generates corresponding notifications. These notifications are either written to the alerts log or sent by email to specified recipients.
InterSystems IRIS writes general messages, errors and traps, and the success or failure of jobs started remotely from other systems to the console log; see Monitoring Log Files in the “Monitoring InterSystems IRIS Using the Management Portal” chapter of this guide for more information. In addition, InterSystems IRIS System Monitor write alerts and warnings to the console log. By generating notifications based on console log contents, InterSystems IRIS Monitor bring alerts to the attention of system operators.
Note:
InterSystems IRIS Monitor does not generate a notification for every console log entry of the configured severity. When there is a series of entries from a given process within less than about an hour of each other, a notification is generated for the first entry only. For this reason, you should immediately consult the console log (and view System Monitor alerts, if applicable) on receiving a single notification from InterSystems IRIS Monitor. However, the console log entries listed in InterSystems IRIS Monitor Errors and Traps always generate notifications.
InterSystems IRIS Monitor operates with the following settings by default:
You can configure and manage InterSystems IRIS Monitor, including changing its default settings and configuring email notifications, using the interactive ^MONMGR utility.
Using the ^MONMGR Utility
The InterSystems IRIS Monitor Manager (^MONMGR) utility must be executed in the %SYS namespace (the name is case-sensitive).
  1. To start the InterSystems IRIS Monitor Manager, enter the following command in the Terminal:
    %SYS>do ^MONMGR
    
  2. The main menu appears. Enter the number of your choice or press Enter to exit the InterSystems IRIS Monitor Manager:
    1) Start/Stop/Update MONITOR
    2) Manage MONITOR Options
    3) Exit
    
    Option? 
    
The options in the main menu let you manage InterSystems IRIS Monitor as described in the following table:
Option Description
1) Start / Stop / Update Monitor Displays the Start/Stop/Update Monitor submenu which lets you manage InterSystems IRIS Monitor and the alerts log.
2) Manage MONITOR Options Displays the Manage Monitor Options submenu which lets you manage InterSystems IRIS Monitor notification options (sampling interval, severity level, email).
3) Exit Exits from the InterSystems IRIS Monitor Manager.
Start/Stop/Update Monitor
This submenu lets you manage the operation of the InterSystems IRIS Monitor Manager. Enter the number of your choice or press Enter to return to the main menu:
Option? 1

1) Update MONITOR
2) Halt MONITOR
3) Start MONITOR
4) Reset Alerts
5) Exit

Option?
The options in this submenu let you manage the operation of InterSystems IRIS Monitor as described in the following table:
Option Description
1) Update MONITOR Dynamically restarts InterSystems IRIS Monitor based on the current settings (interval, severity level, email) in Manage Monitor Options.
2) Halt MONITOR Stops InterSystems IRIS Monitor. The console log is not scanned until InterSystems IRIS Monitor is started.
3) Start MONITOR Starts InterSystems IRIS Monitor. The console log is monitored based on the current settings (interval, severity level, email) in Manage Monitor Options.
4) Reset ALERTS Deletes the alerts log (if it exists).
5) Exit Returns to the main menu.
Manage Monitor Options
This submenu lets you manage InterSystems IRIS Monitor’s scanning and notification options. Enter the number of your choice or press Enter to return to the main menu:
Option? 2

1) Set Monitor Interval
2) Set Alert Level
3) Manage Email Options
4) Exit

Option?
The options in this submenu let you manage the operation of InterSystems IRIS Monitor as described in the following table:
Option Description
1) Set Monitor Interval Lets you change the interval at which the console log is scanned. InterSystems recommends an interval no longer than the default of 10 seconds.
2) Set Alert Level Lets you set the severity level of console log entries generating notifications, as follows:
  • 1 – warning, severe and fatal
  • 2 – severe and fatal
  • 3 – fatal only
3) Manage Email Options Lets you configure InterSystems IRIS Monitor email notifications using the Manage Email Options submenu.
4) Exit Returns to the main menu.
Note:
Because InterSystems IRIS Monitor generates a notification only for the first in a series of console log entries from a given process within about an hour, setting the alert level to 1 could mean that when a warning has generated an alerts log entry or email message, a subsequent severity 2 alert from the same process does not generate a notification.
Manage Email Options
The options in this submenu let you configure and enable/disable email. When email is enabled, InterSystems IRIS Monitor sends notifications by email; when it is disabled, notifications are written to the alerts log. Enter the number of your choice or press Enter to return to the Manage Monitor Options submenu:
Option? 3

1) Enable/Disable Email
2) Set Sender
3) Set Server
4) Manage Recipients
5) Set Authentication
6) Test Email
7) Exit

Option? 
The options in this submenu let you manage the email notifications for InterSystems IRIS Monitor as described in the following table:
Option Description
1) Enable / Disable Email Enabling email causes InterSystems IRIS Monitor to:
  • send an email notification for each item currently in the alerts log, if any
  • delete the alerts.log file (if it exists)
  • send email notifications for console log entry of the configured severity from that point forward
Disabling email causes InterSystems IRIS Monitor to write entries to the alerts log.
Enabling/disabling email does not affect other email settings; that is, it is not necessary to reconfigure email options when you enable/disable email.
2) Set Sender Select this option to enter text that indicating the sender of the email, for example Cache Monitor. The text you enter does not have to represent a valid email account. You can set this field to NULL by entering - (dash).
3) Set Server Select this menu item to enter the name and port number (default 25) of the email server that handles email for your site. Consult your IT staff to obtain this information. You can set this field to NULL by entering - (dash).
4) Manage Recipients
This option displays a submenu that lets you list, add, or remove the email addresses to which each notification is sent:
Each valid email address must be added individually; when you select 2) Add Recipient, do not enter more than one address when responding to the Email Address? prompt.
5) Set Authentication Lets you specify the authentication username and password if required by your email server. Consult your IT staff to obtain this information. If you do not provide entries, the authentication username and password are set to NULL. You can set the User field to NULL by entering - (dash).
6) Test Email Sends a test message to the specified recipients using the specified email server.
7) Exit Returns to the Manage Monitor Options submenu.
InterSystems IRIS Monitor Errors and Traps
The following console log errors always generate InterSystems IRIS Monitor notifications: