Skip to content

FIRE ALERT

Description

The FIRE ALERT processor is designed to detect and alert on potential fire conditions within a data processing environment. This processor is particularly useful for scenarios where real-time monitoring and alerting are critical for safety and operational efficiency.


Config Location

To configure the FIRE ALERT processor, you need to define it within the schemaAppliedProcessors section of your schema configuration. This involves specifying the processor name and entity.


Supported Data Types

  • String
  • Double
  • Decimal
  • Integer
  • Json
  • BLOB
  • Boolean

Config Requirements

Config ({}) options are required for the FIRE ALERT processor. If no configuration is provided or if the configuration is improperly set up, a block violation will be thrown. For more information on Apiro violations and their appearance in the Apiro UI or logs, refer to the violations section.


Example Config

Below is an example of how to configure the FIRE ALERT processor in XML format:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<schemaAppliedProcessors>
    <dataBlockProcessors>
        <dataBlockProcessor name="FIRE_TEST_ALERT2" entity="FIRE_ALERT">
            <config>
                <![CDATA[
                    {
                        "description":"this is another test alert",
                        "alertLevel":20
                    }
            ]]>
            </config>
        </dataBlockProcessor>
    </dataBlockProcessors>
</schemaAppliedProcessors>

This configuration specifies a description and an alert level for the FIRE ALERT processor.

Example Result

Upon successful configuration and execution, the FIRE ALERT processor will monitor the specified conditions and trigger an alert based on the defined criteria. For instance, with the provided configuration, an alert with the description "this is another test alert" and an alert level of 20 will be generated if the conditions for a fire alert are met.


Config Parameters

name acceptable values comment
description A string describing the alert
alertLevel An integer representing the severity of the alert (e.g., 10 for low, 20 for medium, 30 for high)

Common Mistakes

  • Ensure that the processor name and entity are correctly defined in the configuration to ensure that the processor is correctly identified and applied during the data processing pipeline.
  • Verify that the alertLevel is set to a valid value that matches the severity levels defined by your system.
  • Remember that the configuration for the FIRE ALERT processor is required. If no configuration, or improper configuration is provided then a block violation will be thrown.