Product Documentation

stream identifier

Sep 12, 2016

The following operations can be performed on "stream identifier":

add | set | unset | rm | show | stat

add stream identifier

Creates a stream identifier. A stream identifier specifies how data is collected and stored for an Action Analytics configuration.

Synopsys

add stream identifier <name> <selectorName> [-interval <positive_integer>] [-SampleCount <positive_integer>] [-sort <sort>] [-snmptrap ( ENABLED | DISABLED )] [-appflowLog ( ENABLED | DISABLED )] [-trackTransactions ( RESPTIME | NONE ) [-maxTransactionThreshold <positive_integer>] [-minTransactionThreshold <positive_integer>] [-acceptanceThreshold <string>] [-breachThreshold <positive_integer>]]

Arguments

name

The name of stream identifier.

selectorName

Name of the selector to use with the stream identifier.

interval

Number of minutes of data to use when calculating session statistics (number of requests, bandwidth, and response times). The interval is a moving window that keeps the most recently collected data. Older data is discarded at regular intervals.

Default value: 1

Minimum value: 1

SampleCount

Size of the sample from which to select a request for evaluation. The smaller the sample count, the more accurate is the statistical data. To evaluate all requests, set the sample count to 1. However, such a low setting can result in excessive consumption of memory and processing resources.

Default value: 1

Minimum value: 1

Maximum value: 65535

sort

Sort stored records by the specified statistics column, in descending order. Performed during data collection, the sorting enables real-time data evaluation through NetScaler policies (for example, compression and caching policies) that use functions such as IS_TOP(n).

Possible values: REQUESTS, CONNECTIONS, RESPTIME, BANDWIDTH, RESPTIME_BREACHES, NONE

Default value: REQUESTS

snmptrap

Enable/disable SNMP trap for stream identifier

Possible values: ENABLED, DISABLED

Default value: DISABLED

appflowLog

Enable/disable Appflow logging for stream identifier

Possible values: ENABLED, DISABLED

Default value: DISABLED

trackTransactions

Track transactions exceeding configured threshold. Transaction tracking can be enabled for following metric: ResponseTime.

By default transaction tracking is disabled

Possible values: RESPTIME, NONE

Default value: NONE

maxTransactionThreshold

Maximum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute.

Default value: 0

Minimum value: 0

minTransactionThreshold

Minimum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute.

Default value: 0

Minimum value: 0

acceptanceThreshold

Non-Breaching transactions to Total transactions threshold expressed in percent.

Maximum of 6 decimal places is supported.

Default value: 0.000000

breachThreshold

Breaching transactions threshold calculated over interval.

Default value: 0

Minimum value: 0

Example

add stream identifier stream_id top_url -interval 10 -sampleCount 1 -sort REQUESTS

set stream identifier

Modifies the specified parameters of a stream identifier. Parameters for which a default value is available revert to their default values.

Synopsys

set stream identifier <name> [-selectorName <string>] [-interval <positive_integer>] [-SampleCount <positive_integer>] [-sort <sort>] [-snmptrap ( ENABLED | DISABLED )] [-appflowLog ( ENABLED | DISABLED )] [-trackTransactions ( RESPTIME | NONE )] [-maxTransactionThreshold <positive_integer>] [-minTransactionThreshold <positive_integer>] [-acceptanceThreshold <string>] [-breachThreshold <positive_integer>]

Arguments

name

The name of stream identifier.

selectorName

Name of the selector to use with the stream identifier.

interval

Number of minutes of data to use when calculating session statistics (number of requests, bandwidth, and response times). The interval is a moving window that keeps the most recently collected data. Older data is discarded at regular intervals.

Default value: 1

Minimum value: 1

SampleCount

Size of the sample from which to select a request for evaluation. The smaller the sample count, the more accurate is the statistical data. To evaluate all requests, set the sample count to 1. However, such a low setting can result in excessive consumption of memory and processing resources.

Default value: 1

Minimum value: 1

Maximum value: 65535

sort

Sort stored records by the specified statistics column, in descending order. Performed during data collection, the sorting enables real-time data evaluation through NetScaler policies (for example, compression and caching policies) that use functions such as IS_TOP(n).

Possible values: REQUESTS, CONNECTIONS, RESPTIME, BANDWIDTH, RESPTIME_BREACHES, NONE

Default value: REQUESTS

snmptrap

Enable/disable SNMP trap for stream identifier

Possible values: ENABLED, DISABLED

Default value: DISABLED

appflowLog

Enable/disable Appflow logging for stream identifier

Possible values: ENABLED, DISABLED

Default value: DISABLED

trackTransactions

Track transactions exceeding configured threshold. Transaction tracking can be enabled for following metric: ResponseTime.

By default transaction tracking is disabled

Possible values: RESPTIME, NONE

Default value: NONE

maxTransactionThreshold

Maximum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute.

Default value: 0

Minimum value: 0

minTransactionThreshold

Minimum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute.

Default value: 0

Minimum value: 0

acceptanceThreshold

Non-Breaching transactions to Total transactions threshold expressed in percent.

Maximum of 6 decimal places is supported.

Default value: 0.000000

breachThreshold

Breaching transactions threshold calculated over interval.

Default value: 0

Minimum value: 0

Example

set stream identifier stream_id -selectorName top_clients -interval 1 -sampleCount 1 -sort NONE

unset stream identifier

Use this command to remove stream identifier settings.Refer to the set stream identifier command for meanings of the arguments.

Synopsys

unset stream identifier <name> [-selectorName] [-interval] [-SampleCount] [-sort] [-snmptrap] [-appflowLog] [-trackTransactions] [-maxTransactionThreshold] [-minTransactionThreshold] [-acceptanceThreshold] [-breachThreshold]

rm stream identifier

Removes a stream identifier. Note: You cannot remove a stream identifier if it is being used in a policy.

Synopsys

rm stream identifier <name>

Arguments

name

The name of stream identifier.

Example

rm stream identifier stream_id

show stream identifier

Displays the parameters of the specified stream identifier or, if no stream identifier name is specified, the parameters of all configured stream identifiers.

Synopsys

show stream identifier [<name>]

Arguments

name

The name of stream identifier.

Outputs

selectorName

Name of the selector to use with the stream identifier.

rule

Rule.

ngname

Nodegroup name to which this identifier belongs to.

recordlimit

Maximum number of objects allowed per identifier.

interval

Number of minutes of data to use when calculating session statistics (number of requests, bandwidth, and response times). The interval is a moving window that keeps the most recently collected data. Older data is discarded at regular intervals.

SampleCount

Size of the sample from which to select a request for evaluation. The smaller the sample count, the more accurate is the statistical data. To evaluate all requests, set the sample count to 1. However, such a low setting can result in excessive consumption of memory and processing resources.

sort

Sort stored records by the specified statistics column, in descending order. Performed during data collection, the sorting enables real-time data evaluation through NetScaler policies (for example, compression and caching policies) that use functions such as IS_TOP(n).

snmptrap

Enable/disable SNMP trap for stream identifier

appflowLog

Enable/disable Appflow logging for stream identifier

trackTransactions

Track transactions exceeding configured threshold. Transaction tracking can be enabled for following metric: ResponseTime.

By default transaction tracking is disabled

maxTransactionThreshold

Maximum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute.

minTransactionThreshold

Minimum per transcation value of metric. Metric to be tracked is specified by tracktransactions attribute.

acceptanceThreshold

Non-Breaching transactions to Total transactions threshold expressed in percent.

Maximum of 6 decimal places is supported.

breachThreshold

Breaching transactions threshold calculated over interval.

log

Location where objects collected on the identifier will be logged.

logInterval

Time interval in minutes for logging the collected objects. Log interval should be greater

than or equal to the inteval of the stream identifier.

logLimit

Maximum number of objects to be logged in the log interval.

builtin

Flag to determine if stream identifier is built-in or not

stateflag

used internally to identify ip addresses returned.

devno

count

Example

show stream identifier stream_id

stat stream identifier

Displays the statistics that the NetScaler appliance has collected for the specified stream identifier.

Synopsys

stat stream identifier <name> [<pattern> ...] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )] [-sortBy <sortBy> [<sortOrder>]]

Arguments

name

Name of the stream identifier.

pattern

Values on which grouping is performed are displayed in the output as row titles. If grouping is performed on two or more fields, their values are separated by a question mark in the row title.

For example, consider a selector that contains the expressions HTTP.REQ.URL and CLIENT.IP.SRC (in that order), on an appliance that has accumulated records of a number of requests for two URLs, example.com/page1.html and example.com/page2.html, from two client IP addresses, 192.0.2.10 and 192.0.2.11.

With a pattern of ? ?, the appliance performs grouping on both fields and displays statistics for the following:

* Requests for example.com/abc.html from 192.0.2.10, with a row title of example.com/abc.html?192.0.2.10.

* Requests for example.com/abc.html from 192.0.2.11, with a row title of example.com/abc.html?192.0.2.11.

* Requests for example.com/def.html from 192.0.2.10, with a row title of example.com/def.html?192.0.2.10.

* Requests for example.com/def.html from 192.0.2.11, with a row title of example.com/def.html?192.0.2.11.

With a pattern of * ?, the appliance performs grouping on only the client IP address values and displays statistics for the following requests:

* All requests from 192.0.2.10, with the IP address as the row title.

* All requests from 192.0.2.11, with the IP address as the row title.

With a pattern of ? *, the appliance performs grouping on only the URL values and displays statistics for the following requests:

* All requests for example.com/abc.html, with the URL as the row title.

* All requests for example.com/def.html, with the URL as the row title.

With a pattern of * *, the appliance displays one set of collective statistics for all the requests received, with no row title.

With a pattern of example.com/abc.html ?, the appliance displays statistics for requests for example.com/abc.html from each unique client IP address.

With a pattern of * 192.0.2.11, the appliance displays statistics for all requests from 192.0.2.11.

detail

Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues

Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes

The number of times, in intervals of seven seconds, the statistics should be displayed.

Default value: 1

Minimum value: 0

logFile

The name of the log file to be used as input.

clearstats

Clear the statsistics / counters

Possible values: basic, full

sortBy

use this argument to sort by specific key

Possible values: Req, BandW, RspTime, Conn, breachcnt

sortOrder

use this argument to specify sort order

Possible values: ascending, descending

Default value: SORT_DESCENDING

Outputs

count

devno

stateflag

Outputs

Stream Session Requests (Req)

Total number of Stream Requests recieved.

Stream Session Bandwidth (BandW)

Total Bandwidth consumed.

Stream Session Response Time (RspTime)

Average response time of the stream session.

Stream Session Connections (Conn)

Current connections on the stream session.

Stream Session Breaching Transactions (breachcnt)

Total Breaching Transactions in configured interval.