Application Delivery Management

Analytics

March 11, 2024

Contributed by:

R C

Each element in the analytics section is used to configure the NetScaler ADM 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	The list of properties of analytics.	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.	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")
        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")
        insights:
          -
            type: hdxinsight
          -
            type: gatewayinsight
<!--NeedCopy-->

Each attribute in the analytics section configures the NetScaler instances to collect AppFlow records on the virtual server identified by the target property.

The target virtual servers and the corresponding allowed insight types are as follows:

Target Virtual Server	Insight Type
lbvserver	webinsight, securityinsight
csvserver	webinsight, securityinsight
vpnserver	hdxinsight, gatewayinsight

Note

IPFIX is the default transport mode used to configure analytics for virtual servers in StyleBooks.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Analytics

March 11, 2024

Contributed by:

R C

March 11, 2024

Contributed by:

R C

Analytics

In this article