How to configure OpenLM Alerts – KB4013
The OpenLM Alerts extension is designed to help you monitor the stability and availability of a licensing system. You can define alert conditions and actions that will be triggered when these conditions are met.
The extension can handle complex conditions for multiple license servers and features. There are several options for how these alerts are displayed: in the EasyAdmin User Interface Alerts widget, as an event in the Application Event Log, or sent as messages to one or multiple email accounts. This document goes over the OpenLM Alerts functionality and configuration options.
To set up a new alert:
1. In the OpenLM EasyAdmin User Interface, click Start → Administration → Alerts Management
2. Click Add Rule to introduce a new Alert condition.
3. Name the new alert (e.g. “alert1”), and set its notification severity level (e.g. “Warning”).
4. Select the timing and frequency on how often the alert condition will be checked, either:
- Pick a date and time or
- Enter a custom CRON pattern (when you check the radio button, the values from option A are converted to a pattern for convenience)
5. Click Save. Now you can define alert rules (conditions and actions).
6. Alert condition:
Click the Type dropdown menu and select a condition type.
The following condition types are available:
- Feature usage percentage: Notify when the usage of a feature is above or below predefined thresholds.
- Duplicate license usage: Notify when a user has checked out the same feature on multiple workstations.
- Feature expiration date: Notify when a feature’s license expiration date is coming up.
- License servers not responding: Notify when a monitored license manager’s status is either DOWN or UNKNOWN. In triad configurations, all servers (or Brokers monitoring the license servers) have to be down for this condition to be triggered.
- Users not assigned to a default group: Notify if users do not have a default group set (i.e. still using the system default “OpenLM_Everyone”)
- Users not assigned to a default project: Notify if users do not have a default project assigned.
- Usage session duration: Notify when a license has been checked out for more than the specified duration.
- a Total number of denials in a predefined period: Notify when the number of license denials surpasses a set threshold during a specified period.
- Persistence queue overflow: Notify and alert when the number of records in OLM_PERSISTED_MESSAGES DB exceeds a certain limit.
Once selected, click Add to open the condition configuration window.
7. Condition configuration:
The condition configuration may differ from type to type: some require a threshold number or a period to be typed in, others require specifying a feature or license server, and so on.
For example, let’s take a feature expiration condition with a “<” (less) and 14 days period. This condition will trigger when there are less than 14 days until a license expires.
Click Save to commit the changes.
Click OK once done to commit the settings.
8. Adding multiple conditions:
Additional conditions can be added to a single alert using AND / OR logic. The AND / OR logic is applied serially (without parenthesis). See the image below of two separate conditions (expiration < 14 AND feature usage percentage > 80). This alert will be triggered when there are less than 14 days until the license expiration date and the feature usage percentage is over 80%.
9. Action configuration:
From the Type dropdown menu, select one of the actions to be executed when the alert is triggered:
- Send an email (Easy Admin User Interface Email/SMS configuration required)
- Send an SMS (Easy Admin User Interface Email/SMS configuration required)
- Show application alert – show an alert in the EasyAdmin User Interface Alerts window
- Create an Event Log – write an event in the Windows Application Event Log
- Run a program on OpenLM Server – run a program or command on the machine that hosts the OpenLM Server
- Run a Broker command on LM Server – run one of the standard Broker commands (start, stop, re-read the license file, restart) or a custom one on the license manager machine.
Click Add to open the action configuration window and define specific parameters for the selected action type.
10. Define action type-specific settings:
- Address (email and SMS only) – the email or SMS number to send the alert to.
- Users (email and SMS only) – send an email or SMS to a specific OpenLM user (provided he has the email/phone specified in his user profile).
- Notification mode – define whether this action will be run only once or every time the alert condition is triggered.
- Command (Broker and OpenLM Server action only):
- For Broker this can be either the start/stop / reread / restart or a custom command
- For OpenLM Server the command is executed as:
- Limit sending times – restrict the execution of this action to a certain time. E.g. can be used to avoid sending emails or SMS messages at early hours. A time can either be picked or entered in the custom pattern field as a CRON expression.
- Customized Title (email, SMS, application, or Event Log only)- a custom title
Click OK when done configuring to close the window.
Note: as with conditions, an alert can have multiple actions.
11. Click Save to commit the alert configuration.
Every alert query consumes system resources, hence a good alert system should contain the minimum number of checks that would ensure a stable and effective licensing system.
OpenLM Alerts may be sent via email or SMS text message. Email / SMS services need to be configured accordingly:
- Click the EasyAdmin Start → Administration.
- Click the Email / SMS icon
- Select either one of the tabs and configure the parameters accordingly.
- Click Save to commit the settings. Note that with email, you will have to send at least one test email before you can save the configuration.
Note: if using Google’s G-Suite SMTP servers, the password must be set as the App Password as per Google’s steps