Analytics
Each element in the analytics section is used to configure the NetScaler Console analytics feature for one or more virtual servers created in StyleBooks.
An element in the analytics section has the following attributes:
| Attribute | Description | Mandatory |
|---|---|---|
| name | Name of the analytics element. | Yes |
| description | A text string describing what this element is. | No |
| condition | A boolean expression. When this condition evaluates to false, the entire analytics element is skipped. | No |
| repeat | Iterates over a list. | No |
| repeat-condition | A boolean expression. If the expression evaluates to false, the current iteration is skipped. | No |
| repeat-item | Name of the item in the current iteration. | No |
| repeat-index | Name of the index value of the current iteration. | No |
| properties | A list of analytics operation properties. | Yes |
| target | One of the properties in the list. The target expression is the name of a virtual server, configured on the NetScaler, for which analytics is collected. | Yes |
| filter | One of the properties in the list. The value of this attribute is a NetScaler advanced policy expression that is used to filter the requests on the virtual server for which analytics is collected. By default, the analytics data is collected on all the traffic passing through the virtual server. | No |
| insights | One of the properties in the list. The value of this attribute is the type of insight data to be collected from the target virtual server. By default, all the allowed insights are configured on the target virtual servers based on virtual server type as specified in Target virtual servers and insight types. | No |
| transport-mode | One of the properties in the list. The value of this attribute is either logstream or ipfix. logstream is the default value. |
No |
| client-side-measurements | One of the properties in the list. The value of this attribute is either ENABLED or DISBALED. DISABLED is the default value. | No |
| http-x-forwarded-for | One of the properties in the list. The value of this attribute is either ENABLED or DISBALED. The attribute enables or disables the X-Forwarded-For header insertion to pass the client IP information to the back end server. DISABLED is the default value. | No |
| enable-hdxinsight-for | One of the properties in the list. The value of this attribute is either ICA or TCP. This attribute enables hdxinsight for specific traffic data. ICA is the default value. |
No |
Example 1: Configuring analytics for a single virtual server
operations:
analytics:
-
name: lbvserver-ops-comp
properties:
target: $components-basic-lb-comp.outputs.lbvserver-name
filter: HTTP.REQ.URL.CONTAINS("catalog")
transport-mode: logstream
client-side-measurements: ENABLED
insights:
-
type: webinsight
-
type: securityinsight
<!--NeedCopy-->
Example 2: Configuring analytics for a list of VPN virtual servers
operations:
analytics:
-
name: vpnvserver-ops-comp
repeat: $outputs.staging-vpnvservers
repeat-item: vpnvsvr
properties:
target: $vpnvsvr.outputs.vpnvserver
filter: HTTP.REQ.URL.CONTAINS("catalog")
http-x-forwarded-for: ENABLED
insights:
-
type: hdxinsight
enable-hdxinsight-for: TCP
<!--NeedCopy-->
Each attribute in the analytics section configures the NetScaler instances to collect AppFlow records on the virtual server identified by the target property.
Target virtual servers and insight types
The target virtual servers and the corresponding allowed insight types are as follows:
| Target Virtual Server | Insight Type |
|---|---|
| lbvserver | webinsight, securityinsight, botinsight |
| csvserver | webinsight, securityinsight, botinsight |
| vpnserver | hdxinsight, gatewayinsight |
Note:
IPFIX is the default transport mode used to configure analytics for virtual servers in StyleBooks.
Analytics
Copied!
Failed!