Analytics_Profile (object)

HTTP analytics profile with configurable options

Properties (* = required):

name type(s) default allowed values description
capturedTrafficExternalLogging boolean false true, false Specifies that the system captures a portion of the application traffic which can then be viewed on the System >> Logs >> Captured Transactions screen
capturedTrafficInternalLogging boolean false true, false Specifies that the system captures a portion of the application traffic and sends it to a remote server
captureFilter object {}   Criteria determining when the system captures a portion of the application traffic
class* string   “Analytics_Profile”  
collectClientSideStatistics boolean false true, false Specifies that the system collects statistics regarding the HTTP request and response times
collectedStatsExternalLogging boolean false true, false Specifies that statistics logs are stored on a remote server
collectedStatsInternalLogging boolean true true, false Specifies that statistics logs are stored in the system
collectGeo boolean false true, false Specifies that the system collects statistics of the names of the countries from which that traffic was sent
collectIp boolean false true, false Specifies that the system collects statistics of the IP addresses of where the traffic came from
collectMaxTpsAndThroughput boolean false true, false Specifies that the system collects statistics for the maximum number of transactions per second, and the maximum amount of traffic moving through the system, both request and response throughput values
collectMethod boolean true true, false Specifies that the system collects statistics about the distribution of HTTP methods found in requests
collectOsAndBrowser boolean true true, false Specifies that the system collect statistics about the OSs and Browsers used to send requests
collectPageLoadTime boolean false true, false Specifies that the system collects statistics of the round-trip latency between client end-users and the servers
collectResponseCode boolean true true, false Specifies that the system collects statistics about the distribution of HTTP response codes returned by the servers
collectSubnet boolean false true, false Specifies that the system collects statistics of client subnets
collectUrl boolean false true, false Specifies that the system collects statistics of requested URLs
collectUserAgent boolean false true, false Specifies that the system collects statistics about browsers used to send traffic
collectUserSession boolean false true, false Specifies that the system collects statistics of the number of unique user sessions in the application traffic, as determined by the value of the configured HTTP cookies found in the requests
countriesForStatCollection array     Specifies the countries for collecting statistics
externalLoggingPublisher object     Reference to a log publisher
label string   “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
notificationByEmail boolean false true, false Specifies that the system sends notifications by e-mail
notificationBySnmp boolean false true, false Specifies that the system sends notifications as SNMP traps
notificationBySyslog boolean false true, false Specifies that the system sends notifications to the syslog
notificationEmailAddresses array     The e-mail addresses of a recipient to whom the system should send email notifications
publishIruleStatistics boolean false true, false Specifies that the system collects and displays statistics according to the expressions written in an iRule
remark string   “^[^x00-x1fx22x5cx7f]*$” Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
sessionCookieSecurity string “ssl-only” “always-secure”, “never-secure”, “ssl-only” Specify whether to secure session cookies
sessionTimeoutMinutes integer 5 5 - 60 The number of minutes of user non-activity ot allow before the system considers the session to be over
subnetsForStatCollection array     Specifies the requested subnets for collecting statistics
urlsForStatCollection array     Specifies the requested URLs for collecting statistics

Analytics_Profile.captureFilter (object)

Criteria determining when the system captures a portion of the application traffic

Default: {}

Properties (* = required):

name type(s) default allowed values description
/*/        
capturedProtocols string “all” “all”, “http”, “https” Specifies whether the system captures traffic data that is sent using any protocol, or a specific type of protocol
capturedReadyForJsInjection string “disabled” “disabled”, “enabled” Specifies whether the system captures all traffic data from all transactions or only from transactions that qualify for JavaScript injection
clientIps array     Specifies the client IP addresses to collect stats for. If none are specified, then all will be collected.
dosActivity string “any” “any”, “mitigated-by-dosl7” Specifies whether the system captures traffic data mitigated by the DoS Layer 7 Enforcer, or traffic regardless of DoS activity
methods array     Specifies whether the system captures traffic data based on the HTTP method that was requested. If none are specified then all will be collected.
nodeAddresses array     Specifies whether the system captures traffic data sent from/to all nodes, or only from/to specific nodes. If none are specified then all will be collected.
requestCapturedParts string “none” “all”, “body”, “headers”, “none” Specifies which parts of the request data the system captures
requestContentFilterSearchPart string “none” “all”, “headers”, “body”, “none”, “uri” Specifies the part of the request that should be filtered by the search string
requestContentFilterSearchString string     Specifies the string the request should be searched for
responseCapturedParts string “none” “all”, “body”, “headers”, “none” Specifies which parts of the response data the system captures
responseCodes array     Specifies whether the system captures traffic data based on the HTTP response status codes that the requests return. If none are specified then all will be collected.
responseContentFilterSearchPart string “none” “all”, “body”, “headers”, “none” Specifies the part of the response that should be filtered by the search string
responseContentFilterSearchString string     Specifies the string the response should be searched for
urlFilterType string “all” “all”, “black-list”, “white-list” Specifies how the URL path prefixes are interpreted
urlPathPrefixes array     Specifies URLs the filter type is to be applied to. If none are specified then all will be collected.
userAgentSubstrings array     Specifies whether the system captures traffic sent from all browsers, or only traffic sent from a specific browser
virtualServers array     Specifies whether the system captures traffic data sent from/to all virtual servers, or only from/to specific virtual servers. If none are specified then all will be collected.

Analytics_Profile.externalLoggingPublisher (object)

Reference to a log publisher

Properties (* = required):

name type(s) default allowed values description
bigip string   “f5bigip” formatted string Pathname of existing BIG-IP log publisher
use string     AS3 pointer to log publisher declaration

Capture_Filter (object)

Criteria determining when the system captures a portion of the application traffic

Properties (* = required):

name type(s) default allowed values description
/*/        
capturedProtocols string “all” “all”, “http”, “https” Specifies whether the system captures traffic data that is sent using any protocol, or a specific type of protocol
capturedReadyForJsInjection string “disabled” “disabled”, “enabled” Specifies whether the system captures all traffic data from all transactions or only from transactions that qualify for JavaScript injection
clientIps array     Specifies the client IP addresses to collect stats for. If none are specified, then all will be collected.
dosActivity string “any” “any”, “mitigated-by-dosl7” Specifies whether the system captures traffic data mitigated by the DoS Layer 7 Enforcer, or traffic regardless of DoS activity
methods array     Specifies whether the system captures traffic data based on the HTTP method that was requested. If none are specified then all will be collected.
nodeAddresses array     Specifies whether the system captures traffic data sent from/to all nodes, or only from/to specific nodes. If none are specified then all will be collected.
requestCapturedParts string “none” “all”, “body”, “headers”, “none” Specifies which parts of the request data the system captures
requestContentFilterSearchPart string “none” “all”, “headers”, “body”, “none”, “uri” Specifies the part of the request that should be filtered by the search string
requestContentFilterSearchString string     Specifies the string the request should be searched for
responseCapturedParts string “none” “all”, “body”, “headers”, “none” Specifies which parts of the response data the system captures
responseCodes array     Specifies whether the system captures traffic data based on the HTTP response status codes that the requests return. If none are specified then all will be collected.
responseContentFilterSearchPart string “none” “all”, “body”, “headers”, “none” Specifies the part of the response that should be filtered by the search string
responseContentFilterSearchString string     Specifies the string the response should be searched for
urlFilterType string “all” “all”, “black-list”, “white-list” Specifies how the URL path prefixes are interpreted
urlPathPrefixes array     Specifies URLs the filter type is to be applied to. If none are specified then all will be collected.
userAgentSubstrings array     Specifies whether the system captures traffic sent from all browsers, or only traffic sent from a specific browser
virtualServers array     Specifies whether the system captures traffic data sent from/to all virtual servers, or only from/to specific virtual servers. If none are specified then all will be collected.