Notification

Monitor includes a facility for e-mailing notifications of events that require attention, such as notifications of license daemons that are down or licenses that are checked out for long periods of time. The vovnotifyd daemon is responsible for sending out notifications.

Web-based Configuration

Using the browser interface, visit the Notification administration page. If visiting this page for the first time, click on the Activate link to enable notification. This step creates the licmon.swd/vovnotifyd directory and the required configuration file, then displays the health check information page:


Figure 1. Health Check Page

This page includes a list of the various health checks that will be performed which can trigger notification e-mails. The actions column allow for enabling/disabling, or editing these checks. Each health check has certain configurable parameters that adjust things such as check and mail frequency, as well as check-specific settings. This page manages the licmon.swd/vovnotifyd/config_aux.tcl file.

Before configuring the health checks, the STMP configuration needs to be established so that email can be sent from the Monitor notification system. This is done by visiting the SMTP configuration page, available from the notification drop-down menu:


Figure 2. SMTP Configuration Page

Fill out the server settings form with the values that will enable a connection with a local STMP server, save, then send a test mail to confirm that the configuration is correct and that mail can be sent.

In some environments, the user name that is used to login to Monitor is not used as the user's email address. For these situations, fill in the User email map page with user name to email address mappings. This page is also available on the notification drop-down menu:


Figure 3. Email Map Page

File-based Configuration

The main configuration file for vovnotifyd is the licmon.swd/vovnotifyd/config.tcl file. A complete, documented example file exists in the installation tree in the common/etc/config/vovnotifyd subdirectory of the installation root:
# Notification configuration file.
# Should be placed in the vovnotifyd directory of the .swd.
# All settings are required unless specified otherwise.
# Unused optional settings should be commented out.

# Create an e-mail address map, stackable, optional
addUserToEmailAddressMap  rtdamgr john@mydomain.com

### Monitor-specific settings
# See notification configuration documentation in Monitor Admin Guide
# ConfigureTag       TAG OPTION VALUE
# ConfigureFeature   FEATURE OPTION VALUE

### Examples:
# ConfigureTag       MGC -poc { john mary }
# ConfigureFeature   EDA/MATLAB -longcheckout 2d -userlongcheckout john 1w -mincap 5 -triggerperc 90
# ConfigureFeature   SIMULINK -poc bob -mincap 10 -triggeruse 12

These parameters should be modified to match that of the SMTP server environment. The vovnotifyd daemon will need to be restarted after making changes to this file. For more information on daemon control, visit the Daemon topic.

Debugging

If the notification configuration does not appear to work, vovnotifyd can be launched in the foreground with increased output verbosity, to aid in debugging the configuration. To do this, first shut down the daemon, then:
% vovproject enable licmon
% cd `vovserverdir -p vovnotifyd`
% vovnotifyd -v -v

Feature and Tag Specific Configurations

Some health checks allow for tag or feature specific configurations. For example, the check for long checkouts (doTestHealthLongCheckouts) works best when you define the meaning of "long" on a per-feature basis. The notification configuration web page, as well as the list below, details the available options.

To configure the health checks, edit the licmon.swd/vovnotifyd/config.tcl file and configure the desired features and/or tags with either ConfigureTag or ConfigureFeature. When redundant settings are found between a tag and a feature, the most specific one wins. In ConfigureFeature, features may be specified in FEATURE form or TAG/FEATURE form. Available options are as follows:

ConfigureTag TAG -poc { USER1 USER2 USERN }
Specify the POC list for the specified tag. These users will be notified for feature-related notifications in addition to the LM administrator user(s).
ConfigureTag TAG -longcheckout TIMESPEC
Specifies the tag-wide long checkout trigger threshold. Set to 0 to disable.
ConfigureTag TAG -userlongcheckout USER TIMESPEC
Specifies a tag and user-specific long checkout trigger threshold for the specified feature. Set to 0 to disable.
ConfigureTag TAG -mincap INTEGER
Specifies a tag-wide minimum capacity for features to be considered for the saturation notification.
ConfigureTag TAG -triggerperc INTEGER
Specifies a tag-wide saturation trigger percentage threshold.
ConfigureTag TAG -daystoexpire INTEGER
Specifies the expiration trigger threshold, in days, for the specified tag.
ConfigureFeature FEATURE -poc { USER1 USER2 USERN }
Specify the POC list for the specified feature. These users will be notified for tag-related notifications in addition to the Altair Monitor administrator user(s).
ConfigureFeature FEATURE -longcheckout TIMESPEC
Specifies the long checkout trigger threshold for the specified feature. Set to 0 to disable.
ConfigureFeature FEATURE -userlongcheckout USER TIMESPEC
Specifies a feature and user-specific long checkout trigger threshold for the specified feature. Set to 0 to disable.
ConfigureFeature FEATURE -mincap INTEGER
Specifies a minimum capacity for the feature to be considered for the saturation notification.
ConfigureFeature FEATURE -triggerperc INTEGER
Specifies the saturation trigger percentage threshold for the specified feature.
ConfigureFeature FEATURE -triggeruse INTEGER
Specifies the saturation trigger concurrent usage number threshold for the specified feature. This setting takes precedence over the triggerperc setting.
ConfigureFeature FEATURE -spanalltags
Consider all tags when calculating percentage and concurrent use for saturation check. This setting is not compatible with features specified in TAG/FEATURE form.

Example TIMESPEC values are: 10s, 5m, 3h, 20d, 4w, and 1y. If specifying multiple configuration items for a single object, the items can be combined in the same line.