Home > Configuration > Analytics > addanalyticsprofile

addanalyticsprofile

Use this method to 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

Syntax



Parameters

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').
This is mandatory parameter.

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.
This is mandatory parameter.

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.
Default value = DISABLED.

httppagetracking

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

httpurl

On enabling this option, the Citrix ADC will log the URL in appflow records
Default value = DISABLED.

httphost

On enabling this option, the Citrix ADC will log the Host header in appflow records
Default value = DISABLED.

httpmethod

On enabling this option, the Citrix ADC will log the method header in appflow records
Default value = DISABLED.

httpreferer

On enabling this option, the Citrix ADC will log the referer header in appflow records
Default value = DISABLED.

httpuseragent

On enabling this option, the Citrix ADC will log User-Agent header.
Default value = DISABLED.

httpcookie

On enabling this option, the Citrix ADC will log cookie header.
Default value = DISABLED.

httplocation

On enabling this option, the Citrix ADC will log location header.
Default value = DISABLED.

urlcategory

On enabling this option, the Citrix ADC will send the URL category record.
Default value = DISABLED.

allhttpheaders

On enabling this option, the Citrix ADC will log all the request and response headers.
Default value = DISABLED.

httpcontenttype

On enabling this option, the Citrix ADC will log content-length header.
Default value = DISABLED.

httpauthentication

On enabling this option, the Citrix ADC will log Authentication header.
Default value = DISABLED.

httpvia

On enabling this option, the Citrix ADC will Via header.
Default value = DISABLED.

httpxforwardedforheader

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

httpsetcookie

On enabling this option, the Citrix ADC will log set-cookie header.
Default value = DISABLED.

httpsetcookie2

On enabling this option, the Citrix ADC will log set-cookie2 header.
Default value = DISABLED.

httpdomainname

On enabling this option, the Citrix ADC will log domain name.
Default value = DISABLED.

httpurlquery

On enabling this option, the Citrix ADC will log URL Query.
Default value = DISABLED.

tcpburstreporting

On enabling this option, the Citrix ADC will log TCP burst parameters.
Default value = ENABLED.

cqareporting

On enabling this option, the Citrix ADC will log TCP CQA parameters.
Default value = DISABLED.

integratedcache

On enabling this option, the Citrix ADC will log the Integrated Caching appflow records
Default value = DISABLED.

grpcstatus

On enabling this option, the Citrix ADC will log the gRPC status headers
Default value = DISABLED.

outputmode

This option indicates the format of REST API POST body. It depends on the consumer of the analytics data.
Default value = NS_ANALYTICS_OUT_MODE_AVRO.

metrics

This option indicates the whether metrics should be sent to the REST collector.
Default value = DISABLED.

events

This option indicates the whether events should be sent to the REST collector.
Default value = DISABLED.

auditlogs

This option indicates the whether auditlog should be sent to the REST collector.
Default value = DISABLED.

servemode

This option is for setting the mode of how data is provided
Default value = NS_ANALYTICS_SERVE_PUSH_MODE.

schemafile

This option is for configuring json schema file containing a list of counters to be exported by metricscollector
Default value = NS_S_ANALYTICS_DEFAULT_SCHEMA_FILE.

metricsexportfrequency

This option is for configuring the metrics export frequency in seconds, frequency value must be in [30,300] seconds range
Default value = 30.
Minimum value = 30.
Maximum value = 300.

analyticsendpointmetadata

If the endpoint requires some metadata to be present before the actual json data, specify the same.

dataformatfile

This option is for configuring the file containing the data format and metadata required by the analytics endpoint.
Default value = NS_S_ANALYTICS_DEFAULT_DATA_FORMAT_FILE.

topn

On enabling this topn support, the topn information of the stream identifier this profile is bound to will be exported to the analytics endpoint.
Default value = DISABLED.

httpcustomheaders

Specify the list of custom headers to be exported in web transaction records.

managementlog

This option indicates the whether managementlog should be sent to the REST collector.
Default value = DEFAULT_MANAGEMENTLOG.

analyticsauthtoken

Token for authenticating with the endpoint. If the endpoint requires the Authorization header in a particular format, specify the complete format as the value to this parameter. For eg., in case of splunk, the Authorizaiton header is required to be of the form - Splunk .

analyticsendpointurl

The URL at which to upload the analytics data on the endpoint

analyticsendpointcontenttype

By default, application/json content-type is used. If this needs to be overridden, specify the value.

Return Value

Returns simpleResult

See Also