AlertHandler

Description:

Creates alerts as bulletins based on a provided action (usually created by a rules engine). Action objects executed with this Handler should contain "category", "message", and "logLevel" attributes.

Additional Details...

Tags:

rules, rules engine, action, action handler, logging, alerts, bulletins

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Default Alert Log Levelalert-default-log-levelinfo
  • trace
  • debug
  • info
  • warn
  • error
The default Log Level that will be used to log an alert message if a log level was not provided in the received action's attributes.
Default Categoryalert-default-categoryRules Triggered AlertThe default category to use when logging alert message if a category was not provided in the received action's attributes.
Default Messagealert-default-messageAn alert was triggered by a rules-based action.The default message to include in alert if an alert message was not provided in the received action's attributes
Include Fact Dataalert-include-factstrue
  • true
  • false
If true, the alert message will include the facts which triggered this action. Default is false.
Enforce Action Typeaction-handler-enforce-typeThe Action Type(s) that should be supported by this handler. If provided any other type an exception will be thrown. This can support a comma delimited list of types (e.g. ALERT,LOG)
Supports Expression Language: true (will be evaluated using variable registry only)
Enforce Levelaction-handler-enforce-type-levelIGNORE
  • IGNORE
  • WARN
  • EXCEPTION
If specific action types are enforced, this setting specifies whether the action should be ignored, a warning should be logged or if an exception is thrown. Default is to ignore the received action.

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.