Server Filters

  • General Information
  • Server Filter Overview
  • Server Filter Details
  • Forward Filters
  • Forward Policies
  • Map

    • General Information

    The Server Filters are used to create user roles, responsibility areas, expert centers, manager views, dedicated external integrations and more by defining restrictions for the forwarding of Indications to multiple target boom Servers and/or the local users or external programs like notification and trouble ticket systems.
    The architecture of the boom Server Filters is based on the following rules:

    • A Forward Filter defines a low level pattern for an attribute of the Indication
    • One or more Forward Filters are assigned to a Forward Policy.
    • Any Forward Filter can be shared between multiple Forward Policies.
    • A Forward Policy contains one or more Forward Conditions that specify the targets (users or external programs) and additional filtering on Severity, Daytime, Availability and KPI attributes
    • The Forward Policy uses boolean 'AND' between Filters and additional attributes except Availability and KPI flags
    • The Forward Policy filters based on the assigned Forward Filters each incoming Indication and forwards matches to the specified Targets (users or exec actions).
    • A logical 'OR' is used if multiple Forward Policies are related to the same Targets

    Indication attributes used in Forward Filters

    • Application
    • Group
    • Object
    • Host
    • Custom Attributes [1...15]
    • Service (reserved)

    'EXEC' Targets (External notifications)

    Any executable or script can be used for external notifications (Target TYPE=EXEC). The Command arguements can contain the following variables that will be automatically resolved by the boom Server:

    VariableDescription
    <$AGENT_IP>boom Agent IP Address
    <$AGENT_ID>boom Agent ID
    <$AGENT_HOST>boom Agent host name
    <$HOST>Host attribute of the indication
    <$APPLICATION>Application attribute
    <$GROUP>Group attribute
    <$OBJECT>Object attribute
    <$SEVERITY>Severity as text
    <$SEVERITY_INT>Severity as integer
    <$NAME>Monitor name (for messages - empty string)
    <$VALUE>Monitor value (for messages = -1)
    <$TIME>Receiving time on the boom Agent side (milliseconds).
    <$STIME>Receiving time on the boom Server side (milliseconds)
    <$TIME_STR>Receiving time on the boom Agent side ("yyyy-MM-dd HH:mm:ss")
    <$STIME_STR>Receiving time on the boom Server side ("yyyy-MM-dd HH:mm:ss")
    <$TYPE_A>Availability flag ( >0 if an Availability metric)
    <$TYPE_K>KPI flag ( >0 if a KPI metric)
    <$TEXT>Full indication text *
    <$TEXT_1LINE>First line of indication text
    <$TEXT_255>First 256 chars of indication text [0...255] *
    <$TEXT_80>First 81 chars of indication text [0...80] *
    <$TEXT_40>First 41 chars of indication text [0...40] *
    <$BOOM_SERVER>boom Server host name
    <$BOOM_SERVER_IP>boom Server IP Address
    * - new line characters will be replaced with spaces.

    Server Filter Overview

    The Server Filter Overview table gives a rough summary of all avaliable Server Filters.

    server filters view


    Server Filter Details

    server filters view


    Forward Filters

    The Forward Filter are the building blocks for the Forward Policies. Each Filter defines a low level pattern for a single attribute of the Indication.

    forward filter dialog


    Edit/New    The Forward Filter Name can be any name that clarifies its purpose. It does not need to be unique because the Filter will be identified by its 'Number'. If the Forward Filter Name will be changed, all Forward Policies that are linked to this Filter will be automatically updated.

    edit forward filters dialog
    Delete    All selected Forward Filters will be deleted from the Forward Filters Table. Please note that all deleted Forward Filters will automatically be removed from the Forward Policies!
    Add to FPolicy    All selected Forward Filters will be added to the Forward Policy that is currently displayed. Please note that the Forward Policy must be saved to finally link the Filters to the Policy.

    Forward Policies

    forward policy

    Forward Policy Details:
    Name    This is the unique name of the Forward Policy.
    Description    A description of the Forward Policy
    active    This will set the Forward Policy status to active. A disabled Forward Policy will not filter any messages.

    You can also activate or deactivate a Server Policy via the context menu of the Forward Policy List (right-click on a Forward Policy):

    server policy context menu

    Targets/Forward Conditions:
    Name    The Forward Condition name is a unique name.
    Activated    This is the activation time.
    Deactivated    This is the deactivation time.
    Availability Metric    Defines if the submitted value that matched with this Condition has an impact on the availability of the monitored system.
    KPI Metric    This flag defines if the submitted value must be treated as a Key Performance Indicator.
    Type    Possible types are: USERS, EXEC

    'EXEC'

    server policy type exec

    The Exec field is mandatory and will be marked red if no data is provided.

    'USERS'

    server policy type users
     
    Severities    Only Indications with selected severities match with the condition.
    Description    A description of the Forward Condition.

    Map

    Map view gives a short overview about relation between Forward Filters, Forward Policies and affected users. Executable targets are not included in the map.