Alerting
The INUBIT software has a alerting mechanism that can be used to obtain information about events as they occur in real-time via e-mail and/or SNMP.
To use alerts, you first need to activate and configure monitoring of the events in question, and then do the same for one or both alerting mechanisms (e-mail/SNMP).
Events Triggering Alerts and Notification Paths
The tables in the next sections list all events triggering alerts and state for each event whether notification via e-mail or SNMP is possible.
Events Triggered by the System Environment
You configure and activate monitoring of the following events in the INUBIT Workbench, Administration > General Settings > Monitoring > System environment:
Event | Description | SNMP | |||
---|---|---|---|---|---|
Time interval for system environment check |
Time interval for checking the hard disk usage and the memory load of the JVM.
|
||||
Activates the monitoring of the hard disk. |
|||||
Max. hard disk usage in % |
Upper limit of hard disk usage; alert is triggered when limit is reached. |
x |
x |
||
JVM memory |
Activates the monitoring of the JVM. |
||||
Max. JVM memory load |
Upper limit of JVM memory load; alert is triggered when limit is reached. |
x |
x |
Events Triggered by the INUBIT Process Engine
Workflows
Monitoring of the following events is activated in the Administration > General Settings > Monitoring > INUBIT Process Engine configuration category.
Event | Description | SNMP | |
---|---|---|---|
Max. size of queue |
Max. number of workflows in queue; alert is triggered when maximum is reached. |
x |
x |
Max. faulty workflows |
Maximum number of faulty workflow executions permissible within a time interval, before the alert is triggered. |
x |
x |
Max. workflow executions |
Maximum number of workflow executions measured in a specified time interval. Exceeding this triggers the alert. |
x |
x |
Connections, timeouts, certificates, licenses and users
Monitoring must be activated individually for following events:
Event | Description | SNMP | |
---|---|---|---|
Canceling a connection to the monitored components |
Monitoring of remote connections, for instance, is configured in the Connection Manager. |
x |
|
Errors and timeouts during Technical Workflows |
Errors and timeouts are displayed in the Queue Manager. To be configured in the Technical Workflow diagrams, refer to Execution Tab - TWF Only. |
x |
|
Expiration of certificates in system connectors |
All monitored certificates are displayed in the Key Manager. Warnings are sent daily beginning two weeks before expiration. Monitoring is triggered with the e-mail alert. |
x |
|
Expiration of the INUBIT license |
Warnings are sent daily beginning two weeks before expiration; License monitoring is triggered with the e-mail alert and SNMP activation, respectively. |
x |
x |
User locked because an incorrect password was entered too many times. |
Refer to Configuring INUBIT User Accounts |
x |
x |
User locked because of inactivity |
x |
x |
|
User deleted because of inactivity |
x |
x |
Activating Workflow Error E-mail Notifications
For alert activating events related to errors in workflows, the INUBIT software may send e-mails to the root user with the System Administrator
role and the e-mail address defined in the configuration.
You can deselect the Notify root user option if you do not want the user |
Refer to
-
For Technical Workflow diagrams you can define individual e-mail recipients, refer to Execution Tab - TWF Only.
-
For a list of events that trigger an alert and may trigger an e-mail notification, refer to Events Triggering Alerts and Notification Paths
Proceed as follows
-
Define an e-mail recipient
-
In the INUBIT Workbench display the Administration > User Roles tab.
-
Expand the
System Administrator
user role folder and select the userroot
. -
Open the context menu and select Edit user data. A dialog opens.
-
Enter a valid e-mail address.
-
Confirm by clicking OK. The dialog closes.
-
-
Activate e-mail notifications
-
Display the Administration > General Settings tab.
-
Select the Monitoring > Workflow error E-Mail notification configuration category.
-
Activate the Notifications activated option.
-
In the Server name field enter the IP address or name of your e-mail server.
-
Activate the Authentication option if the mail server expects a login.
-
Then enter the login name and password.
-
Save the information.
-
Using SMTP/SMTPS
Email notification can be sent via an unencrypted (SMTP) or an encrypted (SMTP with enabled TLS, SMTPS) connection between the INUBIT Workbench and the mail server.
Activating Monitoring E-Mail Notifications
For alert activating events related to license expiry, low memory, and Process Engine crash, the INUBIT software may send e-mails to the root
user with the System Administrator
role and the e-mail address defined in the configuration.
You can deselect the Notify root user option if you do not want the user |
Refer to
-
For Technical Workflow diagrams you can define individual e-mail recipients, refer to After incorrect execution e-mail to.
-
For a list of events that trigger an alert and may trigger an e-mail notification, refer to Events Triggering Alerts and Notification Paths.
Proceed as follows
-
Define an e-mail recipient
-
In the INUBIT Workbench, display the Administration > User Roles tab.
-
Expand the
System Administrator
user role folder and select the userroot
. -
Open the context menu and select Edit user data. A dialog opens.
-
Enter a valid e-mail address.
-
Confirm by clicking OK. The dialog closes.
-
-
Activate e-mail notifications
-
Display the Administration > General Settings tab.
-
Select the Monitoring > Monitoring E-Mail notification configuration category.
-
Activate the Notification activated option.
-
In the Server name field, enter the IP address or name of your e-mail server.
-
Activate the Authentication option if the mail server expects a login.
-
Then enter the login name and password.
-
Save the information.
-
Using SMTP/SMTPS
E-mail notifications can be sent via a secure connection between the INUBIT and the SMTP server (mail server).
You can choose between SMTP and SMTPS.
When having chosen SMTP, you can choose the Enable TLS (StartTLS) option. This will encrypt the connection.
Activating the SNMP Alert
The INUBIT Process Engine can send SNMP traps to an SNMP Manager to report the occurrence of certain events.
The SNMP traps are sent as enterpriseSpecific traps.
The general TrapID
(generic trap type) therefore always has the value 6. Virtimo AG uses the enterprise ID 1.3.6.1.4.1.15899.1.1.2
for INUBIT-generated traps.
For a list of events that trigger an alert and may trigger an e-mail notification, refer to Events Triggering Alerts and Notification Paths.
Events and their traps
If the SNMP alert is activated and the following events occur, the company-specific TrapID
(specific trap code) listed next to it is sent:
Event | TrapID |
---|---|
Max. number of workflow executions during a time frame was exceeded |
1 |
Max. number of faulty workflow executions within the time frame was exceeded |
2 |
Max. number of workflows in the workflow queue was exceeded |
3 |
The configured maximum hard disk capacity is reached. |
4 |
INUBIT Process Engine using more JVM than permitted |
5 |
A user was locked because an incorrect password was entered too many times. |
6 |
A user was locked because of inactivity |
7 |
A user was deleted because of inactivity |
8 |
Warnings about license expiration are sent daily beginning two weeks before expiration. |
9 |
PITR is using more hard disk space than permitted. As of INUBIT 7.0, PITR is no longer supported. |
10 |
The configured maximum hard disk capacity for an INUBIT Process Engine node is reached. This node will be shut down. |
11 |
The INUBIT Process Engine node cannot reach the cache database. The node will be shut down. |
12 |
The INUBIT Process Engine cannot reach the cache database. |
13 |
Examples
-
OID for max. exceeded hard disk space:
.1.3.6.1.4.1.15899.1.1.2.4
-
OID for max. JVM exceeded:
.1.3.6.1.4.1.15899.1.1.2.5
Requirement
-
An SNMP Manager must be installed as the recipient of the SNMP traps.
-
The SNMP traps of the INUBIT Process Engine must be registered in the SNMP Manager. For this purpose the Object Identifier (OID) of the INUBIT software must be stated in the configuration of the SNMP Manager (
.1.3.6.1.4.1.15899.1.1.2
).
Virtimo AG is happy to provide you with an MIB file (Management Information Base) on request. Please contact the support of the Virtimo AG. |
Proceed as follows
-
In the INUBIT Workbench, display the Administration > General Settings tab.
-
Display the Monitoring > SNMP Alarming configuration category.
-
Check the Activate option. With this option you are activating the sending of SNMP traps if the alert is triggered.
-
Fill in the other fields.
-
Save your changes.
The SNMP alerting is now activated.