Product Documentation

STREAM_T

Sep 12, 2016

Stream

This topic lists the expressions that are provided by this class.

BANDWIDTH

Returns the bandwidth on an object.

Returns: unsigned_long_at

CHECK_BREACH_THRESHOLD (stream_transaction_track_mode_e mode)

Returns true if an object corresponding to the stream identifier has hit maximum breaching transactions threshold.
Transaction Tracking needs to be enabled in stream identifier configuration to use this expression. Transaction Tracking mode: RESPONSE TIME in milli seconds.
add stream identifier sid -interval 5 -tracktransactions RESPTIME -maxTransactionThreshold 100 -BreachThreshold 10 Expression: ANALYTIC.STREAM("sid").CHECK_BREACH_THRESHOLD(RESPONSE_TIME)

Parameters (expressions not allowed):

mode - CHECK BREACH mode

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, ip_address_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(BANDWIDTH, 100000)
Note: maxthreshold should always be greater than 0.

Parameters (expressions not allowed):

mode - Check Limit mode

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, num_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(BANDWIDTH, 100000)
Note: maxthreshold should always be greater than 0.

Parameters (expressions not allowed):

mode - Check Limit mode

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, time_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(BANDWIDTH, 100000)
Note: maxthreshold should always be greater than 0.

Parameters (expressions not allowed):

mode - Check Limit mode

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, unsigned_long_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(BANDWIDTH, 100000)
Note: maxthreshold should always be greater than 0.

Parameters (expressions not allowed):

mode - Check Limit mode

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, ip_address_at minthreshold, ip_address_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, ip_address_at minthreshold, num_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, ip_address_at minthreshold, time_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, ip_address_at minthreshold, unsigned_long_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, num_at minthreshold, ip_address_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, num_at minthreshold, num_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, num_at minthreshold, time_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, num_at minthreshold, unsigned_long_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, time_at minthreshold, ip_address_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, time_at minthreshold, num_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, time_at minthreshold, time_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, time_at minthreshold, unsigned_long_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, unsigned_long_at minthreshold, ip_address_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, unsigned_long_at minthreshold, num_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, unsigned_long_at minthreshold, time_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

CHECK_LIMIT (stream_mode_e mode, unsigned_long_at minthreshold, unsigned_long_at maxthreshold)

Returns true if an object corresponding to the stream identifier has hit the limit parameter.
mode: BANDWIDTH in kbps, RESPONSE TIME in milli seconds, REQUEST RATE in Requests/second, CONNECTIONS i.e. Total Active Connections.
add stream identifier sid -interval 5 Expression: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 1000)
Note: maxthreshold and minthreshold cannot be negative. maxthreshold cannot be less than minthreshold.
Note: If maxthreshold is 0, then max threshold is not applied. minthreshold and maxthreshold cannot both be zero. Example: ANALYTIC.STREAM("sid").check_limit(REQUEST_RATE, 10, 0) Above expression returns true only if Request Rate is less than 10 requests per second. There is no upper limit here.

Parameters (expressions not allowed):

mode - Check Limit Mode

minthreshold - Check Limit min threshold

maxthreshold - Check Limit maximum threshold

Returns: bool_at

COLLECT_STATS

Returns true if statistics collection on an object was successful.

Returns: bool_at

COLLECT_STATS (uint amplification_factor)

Returns true if statistics collection on an object was successful.

Parameters (expressions not allowed):

amplification_factor - Amplification factor

Returns: bool_at

CONNECTIONS

Returns the number of connections on an object.

Returns: unsigned_long_at

IS_TOP_FREQUENTS (uint n)

Returns true if a given object is in the top n of a identifier.

Parameters (expressions not allowed):

n - Given object must be in the top n frequents of the collected objects.

Returns: bool_at

IS_TOP (uint n)

Returns true if a given object is in the top n of a identifier.

Parameters (expressions not allowed):

n - Given object must be in the top n of the collected objects.

Returns: bool_at

REQUESTS

Returns the number of requests on an object.

Returns: unsigned_long_at

RESPTIME

Returns the average response time of an object.

Returns: unsigned_long_at