-
-
analytics-profile
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
analytics-profile
The following operations can be performed on “analytics-profile”:
| set | show | update | add | unset | rm |
set analytics profile
Sets an Analytics profile
Synopsis
set analytics profile
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, timeseries, lsninsight, botinsight, CIinsight, udpinsight
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
allHttpHeaders On enabling this option, the Citrix ADC will log all the request and response headers.
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
grpcStatus On enabling this option, the Citrix ADC will log the gRPC status headers
Possible values: ENABLED, DISABLED Default value: DISABLED
outputMode This option indicates the format of REST API POST body. It depends on the consumer of the analytics data.
Possible values: avro, prometheus, influx, json Default value: avro,
metrics This option indicates the whether metrics should be sent to the REST collector.
Possible values: ENABLED, DISABLED Default value: DISABLED
events This option indicates the whether events should be sent to the REST collector.
Possible values: ENABLED, DISABLED Default value: DISABLED
auditlogs This option indicates the whether auditlog should be sent to the REST collector.
Possible values: ENABLED, DISABLED Default value: DISABLED
managementlog This option indicates the whether managementlog should be sent to the REST collector. Default value: DEFAULT_MANAGEMENTLOG
serveMode This option is for setting the mode of how data is provided
Possible values: Push, Pull Default value: Push
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 Maximum value: 64
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
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 Maximum value: 256
analyticsEndpointContentType By default, application/json content-type is used. If this needs to be overridden, specify the value. Maximum value: 128
analyticsEndpointMetadata If the endpoint requires some metadata to be present before the actual json data, specify the same. Maximum value: 128
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 Maximum value: 64
Example
set analytics profile analytics_profile1 -collector 1.2.3.4
show analytics profile
Displays information about all configured Analytics profiles, or about the specified profile.
Synopsis
show analytics profile [
Arguments
name Name of the profile about which to display information.
Output
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.
allHttpHeaders On enabling this option, the Citrix ADC will log all the request and response headers.
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
grpcStatus On enabling this option, the Citrix ADC will log the gRPC status headers
outputMode This option indicates the format of REST API POST body. It depends on the consumer of the analytics data.
metrics This option indicates the whether metrics should be sent to the REST collector.
events This option indicates the whether events should be sent to the REST collector.
auditlogs This option indicates the whether auditlog should be sent to the REST collector.
managementlog This option indicates the whether managementlog should be sent to the REST collector.
serveMode This option is for setting the mode of how data is provided
schemaFile This option is for configuring json schema file containing a list of counters to be exported by metricscollector
httpBodyExport On enabling this option, ADC will export HTTP request and response body
metricsExportFrequency This option is for configuring the metrics export frequency in seconds, frequency value must be in [30,300] seconds range
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.
analyticsEndpointMetadata If the endpoint requires some metadata to be present before the actual json data, specify the same.
apiInfoExport On enabling this option, ADC will export API Information if API Spec is bound to Vserver
dataFormatFile This option is for configuring the file containing the data format and metadata required by the analytics endpoint.
devno count stateflag
Example
show analytics profile prof1
update analytics profile
Updates the data format file of analytics profile
Synopsis
update analytics profile
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’).
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 Maximum value: 64
Example
update analytics profile analytics_profile1 -dataFormatFile
add analytics profile
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
Synopsis
add analytics profile
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, timeseries, lsninsight, botinsight, CIinsight, udpinsight
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
allHttpHeaders On enabling this option, the Citrix ADC will log all the request and response headers.
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
grpcStatus On enabling this option, the Citrix ADC will log the gRPC status headers
Possible values: ENABLED, DISABLED Default value: DISABLED
outputMode This option indicates the format of REST API POST body. It depends on the consumer of the analytics data.
Possible values: avro, prometheus, influx, json Default value: avro,
metrics This option indicates the whether metrics should be sent to the REST collector.
Possible values: ENABLED, DISABLED Default value: DISABLED
events This option indicates the whether events should be sent to the REST collector.
Possible values: ENABLED, DISABLED Default value: DISABLED
auditlogs This option indicates the whether auditlog should be sent to the REST collector.
Possible values: ENABLED, DISABLED Default value: DISABLED
serveMode This option is for setting the mode of how data is provided
Possible values: Push, Pull Default value: Push
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 Maximum value: 64
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. Maximum value: 128
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 Maximum value: 64
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 Maximum value: 256
analyticsEndpointContentType By default, application/json content-type is used. If this needs to be overridden, specify the value. Maximum value: 128
unset analytics profile
Use this command to remove analytics profile settings.Refer to the set analytics profile command for meanings of the arguments.
Synopsis
unset analytics profile
rm analytics profile
Removes an Analytics profile.
Synopsis
rm analytics profile
Arguments
name Name of the profile to remove.
Example
rm analytics profile analytics_profile1
Share
Share
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.