Skip to content

analytics profile

The following operations can be performed on "analytics profile":

add| set| unset| rm| show

add analytics profile

p{white-space: pre-wrap;}

Adds a new Analytics profile. A Profile Specifies what application insight is needed. Also specifies the collector to which the data needs to be exported. example => add analytics profile analytics_profile1 -collector 192.168.1.40 -type webinsight

Synopsys

add analytics profile <name> [-collectors <string>] -type <type> [-httpClientSideMeasurements ( ENABLED | DISABLED )] [-httpPageTracking ( ENABLED | DISABLED )] [-httpURL ( ENABLED | DISABLED )] [-httpHost ( ENABLED | DISABLED )] [-httpMethod ( ENABLED | DISABLED )] [-httpReferer ( ENABLED | DISABLED )] [-httpUserAgent ( ENABLED | DISABLED )] [-httpCookie ( ENABLED | DISABLED )] [-httpLocation ( ENABLED | DISABLED )] [-urlCategory ( ENABLED | DISABLED )] [-httpContentType ( ENABLED | DISABLED )] [-httpAuthentication ( ENABLED | DISABLED )] [-httpVia ( ENABLED | DISABLED )] [-httpXForwardedForHeader ( ENABLED | DISABLED )] [-httpSetCookie ( ENABLED | DISABLED )] [-httpSetCookie2 ( ENABLED | DISABLED )] [-httpDomainName ( ENABLED | DISABLED )] [-httpURLQuery ( ENABLED | DISABLED )] [-tcpBurstReporting ( ENABLED | DISABLED )] [-cqaReporting ( ENABLED | DISABLED )] [-integratedCache ( ENABLED | DISABLED )]

Arguments

name

Name for the analytics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at

(@), equals (=), and hyphen (-) characters.

The following requirement applies only to the Citrix ADC CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my appflow profile" or 'my appflow profile').

collectors

The collector can be an IP, an appflow collector name, a service or a vserver. If IP is specified, the transport is considered as logstream and default port of 5557 is taken. If collector name is specified, the collector properties are taken from the configured collector. If service is specified, the configured service is assumed as the collector. If vserver is specified, the services bound to it are considered as collectors and the records are load balanced.

type

This option indicates what information needs to be collected and exported.

Possible values: global, webinsight, tcpinsight, securityinsight, videoinsight, hdxinsight, gatewayinsight, httpstream, lsninsight

httpClientSideMeasurements

On enabling this option, the Citrix ADC will insert a javascript into the HTTP response to collect the client side page-timings and will send the same to the configured collectors.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpPageTracking

On enabling this option, the Citrix ADC will link the embedded objects of a page together.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpURL

On enabling this option, the Citrix ADC will log the URL in appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpHost

On enabling this option, the Citrix ADC will log the Host header in appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpMethod

On enabling this option, the Citrix ADC will log the method header in appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpReferer

On enabling this option, the Citrix ADC will log the referer header in appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpUserAgent

On enabling this option, the Citrix ADC will log User-Agent header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpCookie

On enabling this option, the Citrix ADC will log cookie header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpLocation

On enabling this option, the Citrix ADC will log location header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

urlCategory

On enabling this option, the Citrix ADC will send the URL category record.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpContentType

On enabling this option, the Citrix ADC will log content-length header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpAuthentication

On enabling this option, the Citrix ADC will log Authentication header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpVia

On enabling this option, the Citrix ADC will Via header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpXForwardedForHeader

On enabling this option, the Citrix ADC will log X-Forwarded-For header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpSetCookie

On enabling this option, the Citrix ADC will log set-cookie header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpSetCookie2

On enabling this option, the Citrix ADC will log set-cookie2 header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpDomainName

On enabling this option, the Citrix ADC will log domain name.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpURLQuery

On enabling this option, the Citrix ADC will log URL Query.

Possible values: ENABLED, DISABLED

Default value: DISABLED

tcpBurstReporting

On enabling this option, the Citrix ADC will log TCP burst parameters.

Possible values: ENABLED, DISABLED

Default value: ENABLED

cqaReporting

On enabling this option, the Citrix ADC will log TCP CQA parameters.

Possible values: ENABLED, DISABLED

Default value: DISABLED

integratedCache

On enabling this option, the Citrix ADC will log the Integrated Caching appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

set analytics profile

p{white-space: pre-wrap;}

Sets an Analytics profile

Synopsys

set analytics profile <name> [-collectors <string>] [-httpClientSideMeasurements ( ENABLED | DISABLED )] [-httpPageTracking ( ENABLED | DISABLED )] [-httpURL ( ENABLED | DISABLED )] [-httpHost ( ENABLED | DISABLED )] [-httpMethod ( ENABLED | DISABLED )] [-httpReferer ( ENABLED | DISABLED )] [-httpUserAgent ( ENABLED | DISABLED )] [-httpCookie ( ENABLED | DISABLED )] [-httpLocation ( ENABLED | DISABLED )] [-urlCategory ( ENABLED | DISABLED )] [-httpContentType ( ENABLED | DISABLED )] [-httpAuthentication ( ENABLED | DISABLED )] [-httpVia ( ENABLED | DISABLED )] [-httpXForwardedForHeader ( ENABLED | DISABLED )] [-httpSetCookie ( ENABLED | DISABLED )] [-httpSetCookie2 ( ENABLED | DISABLED )] [-httpDomainName ( ENABLED | DISABLED )] [-httpURLQuery ( ENABLED | DISABLED )] [-tcpBurstReporting ( ENABLED | DISABLED )] [-cqaReporting ( ENABLED | DISABLED )] [-integratedCache ( ENABLED | DISABLED )]

Arguments

name

Name for the analytics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at

(@), equals (=), and hyphen (-) characters.

The following requirement applies only to the Citrix ADC CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my appflow profile" or 'my appflow profile').

collectors

The collector can be an IP, an appflow collector name, a service or a vserver. If IP is specified, the transport is considered as logstream and default port of 5557 is taken. If collector name is specified, the collector properties are taken from the configured collector. If service is specified, the configured service is assumed as the collector. If vserver is specified, the services bound to it are considered as collectors and the records are load balanced.

httpClientSideMeasurements

On enabling this option, the Citrix ADC will insert a javascript into the HTTP response to collect the client side page-timings and will send the same to the configured collectors.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpPageTracking

On enabling this option, the Citrix ADC will link the embedded objects of a page together.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpURL

On enabling this option, the Citrix ADC will log the URL in appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpHost

On enabling this option, the Citrix ADC will log the Host header in appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpMethod

On enabling this option, the Citrix ADC will log the method header in appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpReferer

On enabling this option, the Citrix ADC will log the referer header in appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpUserAgent

On enabling this option, the Citrix ADC will log User-Agent header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpCookie

On enabling this option, the Citrix ADC will log cookie header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpLocation

On enabling this option, the Citrix ADC will log location header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

urlCategory

On enabling this option, the Citrix ADC will send the URL category record.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpContentType

On enabling this option, the Citrix ADC will log content-length header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpAuthentication

On enabling this option, the Citrix ADC will log Authentication header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpVia

On enabling this option, the Citrix ADC will Via header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpXForwardedForHeader

On enabling this option, the Citrix ADC will log X-Forwarded-For header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpSetCookie

On enabling this option, the Citrix ADC will log set-cookie header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpSetCookie2

On enabling this option, the Citrix ADC will log set-cookie2 header.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpDomainName

On enabling this option, the Citrix ADC will log domain name.

Possible values: ENABLED, DISABLED

Default value: DISABLED

httpURLQuery

On enabling this option, the Citrix ADC will log URL Query.

Possible values: ENABLED, DISABLED

Default value: DISABLED

tcpBurstReporting

On enabling this option, the Citrix ADC will log TCP burst parameters.

Possible values: ENABLED, DISABLED

Default value: ENABLED

cqaReporting

On enabling this option, the Citrix ADC will log TCP CQA parameters.

Possible values: ENABLED, DISABLED

Default value: DISABLED

integratedCache

On enabling this option, the Citrix ADC will log the Integrated Caching appflow records

Possible values: ENABLED, DISABLED

Default value: DISABLED

Example

set analytics profile analytics_profile1 -collector 1.2.3.4

unset analytics profile

p{white-space: pre-wrap;}

Use this command to remove analytics profile settings.Refer to the set analytics profile command for meanings of the arguments.

Synopsys

unset analytics profile <name> [-httpClientSideMeasurements] [-httpPageTracking] [-httpURL] [-httpHost] [-httpMethod] [-httpReferer] [-httpUserAgent] [-httpCookie] [-httpLocation] [-urlCategory] [-httpContentType] [-httpAuthentication] [-httpVia] [-httpXForwardedForHeader] [-httpSetCookie] [-httpSetCookie2] [-httpDomainName] [-httpURLQuery] [-tcpBurstReporting] [-cqaReporting] [-integratedCache]

rm analytics profile

p{white-space: pre-wrap;}

Removes an Analytics profile.

Synopsys

rm analytics profile <name>

Arguments

name

Name of the profile to remove.

Example

rm analytics profile analytics_profile1

show analytics profile

p{white-space: pre-wrap;}

Displays information about all configured Analytics profiles, or about the specified profile.

Synopsys

show analytics profile [<name>]

Arguments

name

Name of the profile about which to display information.

Outputs

collectors

The collector can be an IP, an appflow collector name, a service or a vserver. If IP is specified, the transport is considered as logstream and default port of 5557 is taken. If collector name is specified, the collector properties are taken from the configured collector. If service is specified, the configured service is assumed as the collector. If vserver is specified, the services bound to it are considered as collectors and the records are load balanced.

refCnt

The number of references to the profile.

type

This option indicates what information needs to be collected and exported.

httpClientSideMeasurements

On enabling this option, the Citrix ADC will insert a javascript into the HTTP response to collect the client side page-timings and will send the same to the configured collectors.

httpPageTracking

On enabling this option, the Citrix ADC will link the embedded objects of a page together.

httpURL

On enabling this option, the Citrix ADC will log the URL in appflow records

httpHost

On enabling this option, the Citrix ADC will log the Host header in appflow records

httpMethod

On enabling this option, the Citrix ADC will log the method header in appflow records

httpReferer

On enabling this option, the Citrix ADC will log the referer header in appflow records

httpUserAgent

On enabling this option, the Citrix ADC will log User-Agent header.

httpCookie

On enabling this option, the Citrix ADC will log cookie header.

httpLocation

On enabling this option, the Citrix ADC will log location header.

urlCategory

On enabling this option, the Citrix ADC will send the URL category record.

httpContentType

On enabling this option, the Citrix ADC will log content-length header.

httpAuthentication

On enabling this option, the Citrix ADC will log Authentication header.

httpVia

On enabling this option, the Citrix ADC will Via header.

httpXForwardedForHeader

On enabling this option, the Citrix ADC will log X-Forwarded-For header.

httpSetCookie

On enabling this option, the Citrix ADC will log set-cookie header.

httpSetCookie2

On enabling this option, the Citrix ADC will log set-cookie2 header.

httpDomainName

On enabling this option, the Citrix ADC will log domain name.

httpURLQuery

On enabling this option, the Citrix ADC will log URL Query.

tcpBurstReporting

On enabling this option, the Citrix ADC will log TCP burst parameters.

cqaReporting

On enabling this option, the Citrix ADC will log TCP CQA parameters.

integratedCache

On enabling this option, the Citrix ADC will log the Integrated Caching appflow records

devno

count

stateflag

Example

show analytics profile prof1