Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To create a new Event Notification configuration, click the New Configuration button in the upper left part of the Desktop window, and then select Event Notification from the menu.

Image RemovedImage Added

An Event Notification configuration

ItemDescription

Event Notifier Enabled

Select this check box to enable event notification. Note, undirected events are not saved by the system, and can therefore not be retrieved.

Notifier Setup

A Notifier is the a target where event messages, configured in the Event Setup, are sent. For instance, to a database table, a log file, or to the System Log.

The overall appearance of the message string is also defined in this tab.

Event Setup

In the Event Setup tab, events to catch are defined. If necessary, the message string defined in the Notifier Setup is also modified.

...

A notifier is defined as the target where event messages are sent. A notifier may output information to any type of database table, log file, SNMP trap, mail, SNS topic, or the standard System Log.

Image RemovedImage Added

Event Notification - Notifier Setup tab

ItemDescription

Notification Type

Select the output type for the notification in this drop-down - list. See the detailed descriptions of the notification types in the section below, Notification Type Configurations.

Duplicate Suppression (sec)

Enter the number of seconds during which an identical event is suppressed from being logged. Default The default value is 0.

Base Configuration

The Base Configuration settings includes include everything needed for the selected Notification Type, such as the location of a log file, database profile, or credentials, etc. For further information see the section below, Notification Type Configurations.

Target Field Configuration

The Target Field Configuration settings are used for constructing the content of the notification, and they vary depending on which Notification Type you have selected. See the section below, Target Field Configuration.

...

The event notification types that you can configure in areconfigure are:

  • Azure Application Insight
  • Database

  • Log File

  • Send Mail

  • Send SNMP Trap

  • Send SNMP Trap, Alarm

  • SNS Topic
  • System Log

Azure Application Insight

Insert excerpt
4.3.1 Azure Application Insight Event
4.3.1 Azure Application Insight Event
nopaneltrue

...

Event fields may be inserted into database tables using either plain SQL statements or calls to stored procedures.

Image RemovedImage Added

Event Notification - Notification Type Database

ItemDescription

Database

The name of the database in which the table resides. Databases are defined in the Database profileprofile configuration.

SQL Statement

Type in any SQL statement, using '?' for variables which that are to be mapped against event fields in the Event Setup tab. Trailing semicolons are not used. In the case of running several statements, they must be embedded in a block.

...

ItemDescription

Directory

The path to the directory where the file in which events are to be logged resides.

Filename

The name of the file in which events are to be logged. In case the file does not exist, it will be created when the first message for the specific event map arrives. New messages are appended.

Size

The maximum size of the file. When this parameter is exceeded, the existing file is renamed and a new one is created upon the arrival of the next event.

The old file will receive an extension to the file name, according to <date_time_milliseconds_timezone>.

Time

The maximum lifetime of a file before it is rotated. When this parameter is exceeded, the existing file is renamed and a new one is created upon the arrival of the next event.

If the time is set to rotate every:

  • hour, rotation is made at the first full-hour shift that which is xx:59.

  • 2 hours, rotation is made in predefined two-hour intervals (0,2,4...22) when turning to the next full hour. For example after 01:59.

  • 3 hours, rotation is made in predefined three-hour intervals (0,3,6, ...21) when turning to the next full hour. For example after 02:59.

  • 4 hours, rotation is made in predefined four-hour intervals (0,4,8, ...20) when turning to the next full hour. For example after 03:59.

  • 6 hours, rotation is made in predefined six-hour intervals (0,6,12 ...21) when turning to the next full hour. For example after 05:59.

  • 8 hours, rotation is made in predefined eight-hour intervals (0,8,16) when turning to the next full hour. For example after 07:59.

  • 12 hours, rotation is made at high noon and at midnight.

  • day, rotation is made at midnight.

  • week, rotation will be done at midnight at the last day of the week.

  • month, rotation will be done at midnight at the last day of the month.

The old file will receive an extension to the file name, according to <date_time_milliseconds_timezone>.

If both Size and Time are set, both behaviors apply.

Separator

Indicates how logged events are separated from one another. Valid options are:

  • Linefeed

  • CR + LF (Carriage return + Linefeed)

  • Comma

  • Colon

  • (None)

Log Line

Text to go into the log file.

For further information, see the section below, Target Field Configuration.

...

It is also possible to send mails emails to one or several recipients when the specified events occur. Make sure the correct mail parameters have been configured in the platform.conf. You must enter a value for the property mz.notifier.mailfrom. See 2.6.4 Platform Properties in the System Administrator's Guide for further information about the mail properties.

Image RemovedImage Added

Event Notification - Notification Type Send Mail

ItemDescription
Sender

The label or name to be displayed in the Sender of the mail. The text in the Sender field will not replace the value of the platform.conf property that is set in mz.notifier.mailfrom.

For further information about how to obtain the text, see the section below, Target Field Configuration.

Recipient

Mail address to one or several recipients. Use a comma to separate, if several. Select Add to select mail addresses, configured for available users.

For further information about how to obtain the text, see the section below, Target Field Configuration.

Subject

The subject/heading of the mail. If Event Contents is selected, newlines will be replaced with spaces to make the subject readable. If the string exceeds 100 characters, it is truncated.

For further information about how to obtain the text, see the section below, Target Field Configuration.

Message

The body of the mail message.

For further information about how to obtain the text, see the section below, Target Field Configuration.

Send SNMP Trap

Events may be sent in the form of SNMP traps to systems configured to receive such information. For the MIB definition, see the $MZ_HOME/etc/mz_trap_mib.txt file.

Note
titleNote!

A new SNMP trap format is now available. For backward compatibility purposes, the previous invalid format will still be used by default. However, if you want to use the new format you can add the property

snmp.trap.format.b

to the platform.conf and set it to true to activate the new values.

You can use the topo Topo command to set the property snmp.trap.format.b:

Code Block
$ mzsh topo set topo://container:<container>/pico:platform/val:config.properties.snmp.trap.format.b true



The value of the agent Address field will be taken from the Container property  pico.rcp.server.host .

Image RemovedImage Added 

Event Notification - Notification Type Send SNMP Trap

ItemDescription

IP Address

The IP address of the target host.

Port

The port on the target host defined for the SNMP communication.

Community

The community name string used for the authentication process.

Version

A list containing the supported SNMP versions.

User Message

A string which will be that is sent out as SNMP traps.

For further information about how to obtain the text, see the section below, Target Field Configuration.

...

This notification type is similar to the section above, Send SNMP Trap, with one difference; It is specifically designed to work for Alarm events.

Image RemovedImage Added 

Event Notification - Notification Type Send SNMP Trap Alarm

...

Selecting this type routes messages, produced by the selected events, as SNS topics to the specified Amazon S3 region.

Image RemovedImage Added

Event Notification - Notification Type SNS Topic

...

Selecting Event Contents assigns the event value of each event's Contents field to the parameter. All event types have a suitable event content text. For instance, referring to the example in the figure Events Can Be Customized to Suit Any Target in 4. Event Notifications, the Event Contents string will be:

...

ItemDescription
Filter

The Filter table enables you to configure the event types to catch. For each event type, a filter may be defined to allow, for instance, a specific Workflow and two specific event severities to pass.

Besides filtering on existing values (for instance Workflow name) it is possible to filter using regular expressions and hard coded strings. Regular expressions according to Java syntax applies. For further information see http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html

Event Field Name

The contents of this column varies depending on the selected event type. For further information about different events, see the section below, Event Fields.

Note that only fields of string type are visible.

Match Value(s)

The filtering criteria that defines what events to catch. Double-clicking a cell opens the Edit Match Value dialog box, from which you select a value.

However, these values are only suggestions. You can also use hard coded strings and regular expressions.

Info
titleExample

For example, entering:

.*idle.*

will match any single lines containing "idle".

Some fields also contain several lines, so entering:

(?s).*idle.*

will match any multi-line content containing "idle".

The default value for each of the components is All.

Note
titleNote!

Some of the Event Fields let you select from four Match Value types: Information, Warning, Error, or Disaster. For the rest of the Event Fields Match Value you use a string. Make sure you enter the exact string format of the relevant Match value. For example : the Event Field timeStamp timestamp can be matched against the string format yyyy-mm-dd.


Field MapMaps variables against event fields. The Field Map table exists only if any of the parameters for the selected notifier type is set to Formatted, Event Field or SQL
Notifier Field

States the Notifier parameter available in the Notifier Setup tab.

If a specific parameter has more than one variable, it will claim one line per variable.

VariableThe name of the variable, as entered in the Notifier Setup tab. If the parameter type is Event Field, this field will be empty.
Event FieldDouble-clicking a cell will display a list, from which the event field, to obtain values from, is selected.
Add Event...Enables you to add an event that you generate by a call from an APL- or Ultra code in the workflow configuration. Click Add Event to configure your event; the new event type is added as a separate tab in the Event Setup.
Remove Event...Removes the currently selected event type tab in the Event Setup dialog.
Refresh Field MapUpdates the Field Map table. Required if parameter population types or formatting fields have been modified in the Notifier Setup tab.

...

An event is an object containing information related to an event in in Image Added. For example, there are Workflow State events that are emitted each time the state of a workflow is changed.

...

An Event Type is comprised of a set of fields containing the original event message, a set of standard workflow-related information, and event-specific fields that are the parameters of the original event message.

...

All event types in the system inherit fields from the Base event type. Workflow-related events inherit fields related to the Workflow event as well, such as agentName. In addition to these, User Defined Events will receive any fields as defined by the user.

...

The user-defined event must be configured in an Ultra Format configuration. Other than the fields entered by the user,  will the system will automatically add basic fields. User Defined Events may only be dispatched from an agent using APL, i e Analysis or Aggregation.

 

User-defined events are sent from Analysis or Aggregation agents

Fields added by the user must be populated manually by using APL commands, while the basic fields are populated automatically. From the basic fields, only category and severity may be assigned values. The other basic fields are read-only, hence it is not possible to assign values to them.


Scroll ignore
scroll-viewportfalse
scroll-pdftrue
scroll-officefalse
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse


Next: