Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Defining Conditions and Rules

    In the Condition and Rule Builder, the top panel lists the available keys and the bottom panel displays the resulting rule. In the top panel, use the checkbox to select the desired key(s). In the bottom panel, click the underlined values to edit the logical operators and properties. An optional Consecutive Occurrences field allows users to specify the number of consecutive occurrences before the rule is triggered. Press OK to build the rule syntax.

    Figure 1: Condition and Rule Builder

    Condition and Rule Builder

    Alternatively, the Include and Exclude condition or Production rule syntax can be typed into the field instead of using the Condition and Rule Builder. Group conditions and production rules must be entered in the form of logical expressions with a pre-defined set of keys. For example, the following condition matches when either ingress utilization or egress utilization is greater than or equal to 75 percent: ingressUtil >= 75 || egressUtil >= 75

    • For a list of available keys while editing the condition or rule field, right-click for a list of suggestions, or consult the Available Keys on page 272 below. This list may be different for different types of elements. If unsure of where to start, right-click at the beginning of a field to see all possible keys. Remember that the field must first be activated for editing by double clicking the field.
    • The following are the supported logical operators for reference:== (Equals), != (Does not equal), ~= (Equals using regular expression), && (And), || (Or), < (Less Than), > (Greater than), <= (Less than or equal), and >= (Greater than or equal)
    • Note that all conditions and rules are case sensitive, and spaces should be used as delimiters between keywords, values, and logical operators. Additionally, quotes (““) should be placed around string values, for example, IPAddress == “1.2.3.4”
    • If an integer value is specified for the utilization, the traffic utilization will be compared as integers. To compare using floating numbers, specify the number as a floating number. For example, “ingressUtil > 75.0” instead of “ingressUtil > 75”.

    Consecutive Occurrences


    The special operator “&=” is used to test for consecutive occurrences of a condition. For example, to test that the ingress or egress utilization has been greater than 75 percent for 3 times in a row, you could use the following expression: (ingressUtil >= 75 || egressUtil >= 75) &= 3


    Available Keys


    Below are a list of the attributes for Interface, Node, and Tunnel elements.

    Note that utilization values are specified in percentages (for example, specify 30 for 30 percent).

    See Defining Conditions and Rules for special syntax involving brackets and units.


    Common Attributes


    • deviceID: The hostname of the device associated with the element. For the Node element type, this is the same as the name. For the Interface element type, this is the node that contains the interface. For the Tunnel element type, this is the head-end of the tunnel.
    • name: The element’s name (For the Node element type, this is the hostname. For the Interface element type, this is the interface name. For the Tunnel element type, this is the tunnel’s name.)
    • type: The element type (Node, Interface, Tunnel)
    • IPAddress: The IP address for the element

    Interface Attributes:


    • bandwidth: The interface bandwidth. Here, g, m, k, are permitted to indicate the units, for example, 100m for 100 Mbps.
    • ingressBytesDelta, egressBytesDelta: The interface ingress/egress traffic in Bytes per second.
    • ingressUtil, egressUtil: Specify an integer value for percentage, for example, 30 for 30 percent.
    • ingressErrorDelta, egressErrorDelta: The number inbound/outbound packets that contained errors per second.
    • ingressDiscardDelta, egressDiscardDelta: The number inbound/outbound packets that are discarded per second.

    Node Attributes


    • nodeType: Hardware type (for example, M5 for Juniper M5, CISCO) used for sla status data
    • sysUptime, lastUptime: Unit is in hundredths of a second

    Tunnel Attributes


    • ingressBytesDelta: The tunnel traffic in Bytes per second.

    CPU Stats Attributes


    • cpuTemp: CPU temperature
    • cpuUtil: CPU utilization
    • memTotal: total memory
    • memUsed: used memory
    • memUtil: memory utilization

    LSP Ping Stats Attributes


    • lsppingAvg: average lsp ping value
    • lsppingMax: max lsp ping value
    • lsppingMin: min lsp ping value
    • lsppingSD: standard deviation lsp ping value

    Latency Stats Attributes


    • latencyAvg: average latency value
    • latencyMax: max latency value
    • latencyMin: min latency value
    • latencySD: standard deviation latency value

    Ping Stats Attributes


    • pingAvg: average ping value
    • pingMax: max ping value
    • pingMin: min ping value
    • pingLossPercent: ping loss percentage

    SLA Stats Attributes


    • slaDNSError, slaDNSRoundTrip, slaTimeOut
    • slaEgressLatencyAvg, slaEgressLatencyMax, slaEgressLatencyMin
    • slaEgressNegJitterAvg, slaEgressNegJitterMax, slaEgressNegJitterMin
    • slaEgressPacketLoss
    • slaEgressPosJitterAvg, slaEgressPosJitterMax, slaEgressPosJitterMin
    • slaEgressRoundTripAvg, slaEgressRoundTripMax, slaEgressRoundTripMin
    • slaHTTPTransactionError, slaHTTPTransactionRoundTrip,

      slaHTTPTransactionTimeOut, slaHTTPTransactionTimeToFirstByte

    • slaIngressLatencyAvg, slaIngressLatencyMax, slaIngressLatencyMin
    • slaIngressNegJitterAvg, slaIngressNegJitterMax, slaIngressNegJitterMin
    • slaIngressPacketLoss
    • slaIngressPosJitterAvg, slaIngressPosJitterMax, slaIngressPosJitterMin
    • slaIngressRoundTripAvg, slaIngressRoundTripMax, slaIngressRoundTripMin
    • slaPacketOutofSequence, slaPacketTimeout
    • slaRoundTripAvg, slaRoundTripMax, slaRoundTripMin
    • slaTCPConnectionError, slaTCPConnectionRoundTrip,

      slaTCPConnectionTimeOut

    • slaUnknownPacketLoss

    Additional Examples


    Element Type

    Scope

    Production Rule

    Explanation

    Interface

    Exclude condition: name ~= fe || name ~= ge || name ~= Ethernet

    ingressUtil > 50.0 || egressUtil > 50.0

    Generates alarm if non-ethernet links have utilization over 50 percent.

    CPUStats

    Include condition: deviceID== “NWK”

    cpuUtil > 90

    Generates alarm if CPU utilization on router NWK exceeds 90 percent.

    Tunnel

     

    ingressBytesDelta > 8000

    Generates alarm if traffic is over 8kB/s = 64kb/s.

    Modified: 2016-11-08