Kourier Integrator Online Help
Kourier generates many events while it runs. By default, the significant events are logged to the Kourier event log, and you view them by running the Event Log Listing. Some of these events are informational and largely ignored. Others, however, are worthy of immediate attention. Any one of these events can trigger a filter that can notify a user via e-mail or suppress the event from being logged.
Events can be logged in any number of log targets. Examples of log targets include: the Kourier event log; displayed on the console; or an email notification. For each target, you can control the minimum level of severity that can get logged. If no value is specified, then Kourier uses the settings as shown below:
|
Target |
Default Threshold |
Description |
|---|---|---|
|
Log File |
INFO |
Events are saved in the Kourier Event Log file |
|
|
INFO |
Events are sent as text to one or more email recipients |
|
Console |
NONE |
Events are displayed on the console |
Events have increasing levels of severity and have varying uses as shown below:
|
Type |
Severity Level |
Description |
|---|---|---|
|
ERR |
1 |
Severe event that prevents a process from completing properly |
|
WARN |
2 |
A serious event where processing completed, but requires some amount of review |
|
INFO |
3 |
The process completed normally with no errors |
|
TRACE |
4 |
Events used to track progress of a running process |
|
DEBUG |
5 |
Events used to identify problems errors in program logic flow |
|
VERBOSE |
6 |
Extremely detailed information used to debug problems in programs |
When there are no event filters, no e-mail notifications are sent, and all events are logged. Kourier is delivered with the most common filters. Use this process to modify them or create new ones.
Determine the events that send notifications or get suppressed by entering an event filter. An event filter is specified by entering filter criteria which can be determined by inspecting the fields displayed in the Event Log Listing.
An event triggers a filter only when all the entered filter criteria matches that of the event. If filter criteria field is left blank in a filter, it always matches that field of the event. For example, if a filter's type is INFO and all other filter criteria are blank, every event with type INFO will trigger the filter, regardless of the service, source, or event. That filter will not trigger for any event with type ERR or WARN.
The first criteria that matches the properties of an event will cause that event to trigger. A single event does not trigger multiple filters. Therefore, you should specify the most specific filters first followed by the more general filters last.
See the example below for how to define a good event notification configuration.
|
|
Click the Save icon in the toolbar to save the current settings for the event notification and configuration. |
|
|
Click the Help balloon to open the help for this page. |
KT_CONTROL/EVENT-FILTER
If you create a filter to send an e-mail notification, the template that you specify must be created using E-mail Message Templates and must be written for the proper e-mail message template context. In this case, the context passed is the event log record that is about to be logged.
Be careful not to create a filter with all the filter fields blank and log set to N. This can prevent most or all events from being logged, making it difficult to detect and debug issues.
|
Field Name |
Description - Usage - Notes |
|
Log File |
Select the minimum severity of an event that is sent to the Kourier event log file. |
|
|
Select the minimum severity of an event that can issue an email. |
|
Console |
Select the minimum severity of an event that is sent to the console or CRT. |
|
Event Log Size |
Enter the maximum number of events that should be stored in the Kourier event log file. If this number is decreased from its prior value, Kourier will automatically trim the event log file to the new number. |
Click the Add button in the line item section command bar to add a new Property. See help for Event Log Notification Line Item for form information.
