RLF Schema Statistics

The RLF schema provides the aggregated information for context statistics associated with Rate Limiting Function (RLF) feature used by the following products:
  • GGSN
  • P-GW
This schema provides the following types of statistics:
  • Counter: A counter records incremental data cumulatively and rolls over when the counter limit is reached.
    • All counter statistics are cumulative and reset only by one of the following methods: roll-over when the limit is reached, after a system restart, or after a clear command is performed.
    • The limit depends upon the data type.
  • Gauge: A gauge statistic indicates a single value; a snapshot representation of a single point in time within a defined time frame. The gauge changes to a new value with each snapshot though a value may repeat from one period to the next. The limit depends upon the data type.
  • Information: This type of statistic provides information, often intended to differentiate sets of statistics; for example, a VPN name or IP address. The type of information provided depends upon the data type.
The data type defines the format of the data for the value provided by the statistic. The following data types are used in statistics for this schema:
  • Int32/Int64: An integer, either 32-bit or 64-bit:
    • For statistics with the Int32 data type, the roll-over to zero limit is 4,294,967,295.
    • For statistics with the Int64 data type, the roll-over to zero limit is 18,446,744,073,709,551,615.
  • Float: A numeric value that includes decimal points; for example, 1.345.
  • String: A series of ASCII alphanumeric characters in a single grouping, usually pre-configured.

IMPORTANT:

Unless otherwise indicated, all statistics are counters and all statistics are standards-based.

Key Variables: Every schema has some variables which are typically referred to as “key variables”. These key variables provide index markers to identify which object the statistics apply to. For example, in the card schema the card number (variable %card%) uniquely identifies a card. For an HA service, the keys would be “%vpnname%” plus “%servname%’, as the combination uniquely identifies an HA service. So, in a given measurement interval, one row of statistics will be generated per unique key. The schema keys are identified in the Description section of the table.


Table 1. Bulk Statistic Variables in the RLF Schema
Variables Description Data Type

rlf-ctx-name

Description:The name of the RLF context.

Triggers:Triggered when a valid RLF template is configured and is bound to an open peer

Availability:Per RLF context

Type:

String

rlf-template-name

Description:The name of RLF template.

Triggers:Triggered when a valid RLF template is configured

Availability: Per RLF context

Type:

String

rlf-cfg-tps

Description:Has the configured RLF TPS

Triggers: Triggered when TPS is set for a RLF template

Availability: Per RLF context

Type:

Int64

rlf-state

Description:Has the current RLF state

Triggers: Triggered when RLF context is created for an open peer

Availability:Per RLF context

Type:

String

rlf-storage

Description: Has the RLF storage type

Triggers:Triggered when RLF context is created for an open peer

Availability: Per RLF context

Type:

String

rlf-direction

Description: Has the direction in which messages reach RLF (inbound/outbound peer)

Triggers: Triggered when RLF context is created for an open peer

Availability:Per RLF context

Type:

String

rlf-tot-active-time

Description:Measures the total time in sec, since the first message reached RLF and RLF became active

Triggers: Triggered when a message reaches RLF

Availability:Per RLF context

Type:Counter

Int64

rlf-curr-queue-size

Description: Measures the number of messages currently in the RLF queue

Triggers: Triggered when a message is queued in RLF

Availability: Per RLF context

Type: Gauge

Int64

rlf-avg-tps

Description: Measures the average TPS in which messages flow through RLF

Triggers: Triggered when the average TPS in which messages flow through RLF changes

Availability: Per RLF context

Type:Gauge

Int64

rlf-trend-tps

Description:Measures the trend TPS of messages flowing through RLF

Triggers:Triggered when there is change in number of messages flowing through RLF

Availability:Per RLF context

Type: Gauge

Int64

rlf-10sec-avg-tps

Description: Measures the average RLF TPS for the last 10 seconds

Triggers: Triggered when there is change in number of messages flowing through RLF

Availability: Per RLF context

Type:Gauge

Int64

rlf-30sec-avg-tps

Description: Measures the average RLF TPS for the last 20 seconds

Triggers: Triggered when there is change in number of messages flowing through RLF

Availability: Per RLF context

Type: Gauge

Int64

rlf-60sec-avg-tps

Description: Measures the average RLF TPS for the last 60 seconds

Triggers:Triggered when there is change in number of messages flowing through RLF

Availability: Per RLF context

Type:Gauge

Int64

rlf-5min-avg-tps

Description: Measures the average RLF TPS for the last 5 minutes

Triggers: Triggered when there is change in number of messages flowing through RLF

Availability: Per RLF context

Type: Gauge

Int64

rlf-10min-avg-tps

Description: Measures the average RLF TPS for the last 10 minutes

Triggers: Triggered when there is change in number of messages flowing through RLF

Availability: Per RLF context

Type:Gauge

Int64

rlf-avg-bypass-tps

Description:Measures the average TPS, when RLF has been bypassed using hidden CLI (rlf-bypass diamproxy)

Triggers:Triggered when RLF has been bypassed and messages are pumped out

Availability:Per RLF context

Type: Gauge

Int64

rlf-10sec-avg-bypass-tps

Description:Measures the average RLF TPS for the last 10 seconds, when RLF has been bypassed using hidden CLI (rlf-bypass diamproxy)

Triggers: Triggered when RLF has been bypassed and messages are pumped out

Availability: Per RLF context

Type: Gauge

Int64

rlf-30sec-avg-bypass-tps

Description: Measures the average RLF TPS for the last 30 seconds, when RLF has been bypassed using hidden CLI (rlf-bypass diamproxy)

Triggers:Triggered when RLF has been bypassed and messages are pumped out

Availability: Per RLF context

Type: Gauge

Int64

rlf-60sec-avg-bypass-tps

Description: Measures the average RLF TPS for the last 60 seconds, when RLF has been bypassed using hidden CLI (rlf-bypass diamproxy)

Triggers: Triggered when RLF has been bypassed and messages are pumped out

Availability: Per RLF context

Type: Gauge

Int64

rlf-5min-avg-bypass-tps

Description: Measures the average RLF TPS for the last 5 minutes, when RLF has been bypassed using hidden CLI (rlf-bypass diamproxy)

Triggers: Triggered when RLF has been bypassed and messages are pumped out

Availability:Per RLF context

Type:Gauge

Int64

rlf-10min-avg-bypass-tps

Description:Measures the average RLF TPS for the last 10 minutes, when RLF has been bypassed using hidden CLI (rlf-bypass diamproxy)

Triggers: Triggered when RLF has been bypassed and messages are pumped out

Availability: Per RLF context

Type: Gauge

Int64

rlf-threshold-exceeded

Description: Measures the number of times the RLF threshold has been exceeded

Triggers: Triggered when number of messages in the RLF queue exceeds the thresholds

Availability: Per RLF context

Type:Counter

Int64

rlf-queued

Description:Measures the number of times messages were queued in RLF

Triggers: Triggered when a message is queued in RLF

Availability:Per RLF context

Type: Counter

Int64

rlf-dropped

Description:Measures the number of times messages were dropped, as the RLF queue was full

Triggers: Triggered when a message is dropped from RLF (RLF queue full)

Availability: Per RLF context

Type: Counter

Int64

rlf-directly-sent

Description: Measures the number of times a message was directly sent out without queueing

Triggers: Triggered when a message is directly sent out of RLF

Availability: Per RLF context

Type: Counter

Int64

rlf-queue-bypassed

Description: Measures the number of messages that reached RLF, when it was in "bypass"

Triggers: Triggered when RLF is configured to be bypassed and a message reaches RLF

Availability: Per RLF context

Type: Counter

Int64

rlf-send-msg-cb-failed

Description: Measures the number of times messenger failed to call the callback, after sending out the message from RLF

Triggers: Triggered when it fails to call the "send message callback"

Availability: Per RLF context

Type: Counter

Int64

rlf-status-update-cb-failed

Description: Measures the number of times messenger failed to call the "status update callback"

Triggers: Triggered when it fails to call the "status update callback"

Availability:Per RLF context

Type: Counter

Int64

IMPORTANT:

For information on statistics that are common to all schema see the Statistics and Counters Overview chapter.