ltm profile analytics
ltm profile analytics(1) BIG-IP TMSH Manual ltm profile analytics(1)
NAME
analytics - Configures an analytics profile.
MODULE
ltm profile
SYNTAX
Configure the analytics component within the ltm profile module using the syntax shown in the following
sections.
CREATE/MODIFY
create analytics [name]
modify analytics [name]
options:
alerts [none | add | delete | modify | replace-all-with] {
name [string] {
options:
app-service [[string] | none]
granularity [application | pool-member |
virtual-server]
metric [average-page-load-time | average-request-throughput |
average-response-throughput | average-server-latency |
average-tps | max-page-load-time | max-request-throughput |
max-server-latency | max-response-throughput | max-tps]
sample-period [integer]
threshold [integer]
threshold-relation [above | below]
}
}
app-service [[string] | none]
captured-traffic-external-logging [enabled | disabled]
captured-traffic-internal-logging [enabled | disabled]
collect-page-load-time [enabled | disabled]
collect-geo [enabled | disabled]
collect-http-throughput [enabled | disabled]
collect-http-timing-metrics [enabled | disabled]
collect-ip [enabled | disabled]
collect-max-tps-and-throughput [enabled | disabled]
collect-methods [enabled | disabled]
collect-response-codes [enabled | disabled]
collect-server-latency [enabled | disabled]
collect-subnets [enabled | disabled]
collect-url [enabled | disabled]
collect-user-agent [enabled | disabled]
collect-user-sessions [enabled | disabled]
collected-stats-external-logging [enabled | disabled]
collected-stats-internal-logging [enabled | disabled]
defaults-from [ analytics profile name [string] | none]
description [string]
external-logging-publisher [name]
notification-by-email [enabled | disabled]
notification-by-snmp [enabled | disabled]
notification-by-syslog [enabled | disabled]
notification-email-addresses [none | add | delete | modify |
replace-all-with] { email-address [string] }
publish-irule-statistics [enabled | disabled]
sampling [enabled | disabled]
session-cookie-security [always-secure | ssl-only | never-secure]
session-timeout-minutes [integer]
smtp-config [ smtp configuration object name ]
subnet-masks [none | add | delete | modify |
replace-all-with] {
name [string] {
options:
subnet [IPv4/IPv6 address]
}
countries-for-stat-collection [add | delete]
ips-for-stat-collection [add | delete]
subnets-for-stat-collection [add | delete]
urls-for-stat-collection [add | delete]
}
traffic-capture [none | add | delete | modify |
replace-all-with] {
name [string] {
options:
app-service [[string] | none]
captured-protocols [all | http | https]
client-ips [none | add | delete | modify |
replace-all-with] { ipv4.address }
dos-activity [any | mitigated-by-dosl7]
methods [none | add | delete | modify |
replace-all-with] { method [string] }
node-addresses [none | add | delete | modify |
replace-all-with] { node }
request-captured-parts [all | body | headers | none]
request-content-filter-search-part [all | body | headers |
none | uri]
request-content-filter-search-string [none | [string]]
response-captured-parts [all | body | headers | none]
response-codes [none | add | delete | modify |
replace-all-with] { response-code [integer] }
response-content-filter-search-part [all | body |
headers | none]
response-content-filter-search-string [none | [string]]
url-filter-type [all | black-list | white-list]
url-path-prefixes [none | add | delete | modify |
replace-all-with] { url-path-prefix [string] }
user-agent-substrings [none | add | delete | modify |
replace-all-with] { user-agent-substring [string] }
virtual-servers [none | add | delete | modify |
replace-all-with] { virtual }
}
}
edit analytics [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list analytics
list analytics [ [ [name] | [glob] | [regex] ] ... ]
show running-config analytics
show running-config analytics [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete analytics [name]
DESCRIPTION
Use the analytics component to create, modify, display, or delete an analytics profile for use with analytics
functionality.
EXAMPLES
create analytics my_analytics_profile defaults-from analytics
Creates a custom analytics profile named my_analytics_profile that inherits its settings from the system
default analytics profile.
list analytics
Displays the properties of all analytics profiles.
OPTIONS
app-service
Specifies the name of the application service to which the profile belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the profile. Only the application service can modify or delete the profile.
alerts
Adds, deletes, or replaces a set of analytics alerts. You can configure the following options for an
analytics alert:
app-service
Specifies the name of the application service to which the alert belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you
cannot modify or delete the alert. Only the application service can modify or delete the alert.
granularity
Specifies a granularity level on which the alert is defined.
The options are:
application
Specifies that an alert is triggered for applications for which a threshold is breached.
pool-member
Specifies that an alert is triggered for pool members for which a threshold is breached.
virtual-server
Specifies that an alert is triggered for virtual servers for which a threshold is breached.
metric
Specifies a metric on which the alert is defined.
The options are:
average-page-load-time
Specifies that an alert is triggered when the average time it takes for the client to respond
to a request breaches the defined threshold.
average-request-throughput
Specifies that an alert is triggered when the average number of bits per second the system
processed, based on requests only, breaches the defined threshold.
average-response-throughput
Specifies that an alert is triggered when the average number of bits per second the system
processed, based on responses only, breaches the defined threshold.
average-server-latency
Specifies that an alert is triggered when the average time it takes for the web server to
respond to a request breaches the defined threshold.
average-tps
Specifies that an alert is triggered when the average number of transactions per second
breaches the defined threshold.
max-page-load-time
Specifies that an alert is triggered when the longest time it takes for the client to respond
to a request breaches the defined threshold.
max-request-throughput
Specifies that an alert is triggered when the maximum number of bits per second the system
processed, based on requests only, breaches the defined threshold.
max-response-throughput
Specifies that an alert is triggered when the maximum number of bits per second the system
processed, based on requests only, breaches the defined threshold.
max-server-latency
Specifies that an alert is triggered when the longest time it takes for the web server to
respond to a request breaches the defined threshold.
max-tps
Specifies that an alert is triggered when the largest number of transactions per second
breaches the defined threshold.
name Specifies a unique name for an alert. This option is required for the commands create, delete, and
modify.
sample-period
Specifies that the alert metric is triggered when the conditions that trigger the alert last a
defined amount of time, measured in seconds. The default value is 300.
threshold
Specifies the threshold that must be breached in order for the system to generate alert.
threshold-relation
Specifies whether the metric value must be below or above the metric.
The options are:
above
Specifies that an alert is issued if metric current value is above the threshold.
below
Specifies that an alert is issued if metric current value is below the threshold.
captured-traffic-external-logging
Enables or disables the external logging of captured traffic.
captured-traffic-internal-logging
Enables or disables the internal logging of captured traffic.
collect-page-load-time
Enables or disables the collection of the page load time statistics. The page load time is the round-trip
latency between client end-users and the servers, that is, the round-trip time between an end-user's
request for a page until the time the response finishes loading.
collect-geo
Enables or disables the collection of the names of the countries from where the traffic was sent.
collect-http-throughput
Enables or disables the collection of throughput statistics. This property has been deprecated. As of
v11.3.0, HTTP throughput is always collected.
collect-http-timing-metrics
Enables or disables the collection of HTTP timing metrics.
collect-ip
Enables or disables the collection of client IPs statistics.
collect-max-tps-and-throughput
Enables or disables the collection of maximum TPS and throughput for all collected entities.
collect-methods
Enables or disables the collection of HTTP methods statistics.
collect-response-codes
Enables or disables the collection of response codes returned by the servers.
collect-server-latency
Enables or disables the collection of server latency statistics. This property has been deprecated. As of
v11.3.0, server latency is always collected.
collect-subnets
Enables or disables the collection of client side subnets.
collect-url
Enables or disables the collection of requested URL statistics.
collect-user-agent
Enables or disables the collection of user agents.
collect-user-sessions
Enables or disables the collection of the unique user sessions.
collected-stats-external-logging
Enables or disables the external logging of the collected statistics.
collected-stats-internal-logging
Enables or disables the internal logging of the collected statistics.
defaults-from
Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings
and values from the parent profile specified. The default value is analytics.
description
User defined description.
external-logging-publisher
Specifies the external logging publisher used to send statistical data to one or more destinations.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
name Specifies a unique name for the component. This option is required for the commands create, delete, and
modify.
notification-by-email
Enables or disables sending the analytics alerts by email.
notification-by-snmp
Enables or disables sending the analytics alerts by SNMP traps. notification-by-syslog must be enabled.
notification-by-syslog
Enables or disables logging of the analytics alerts into the Syslog.
notification-email-addresses
Specifies which email addresses receive alerts by email when notification-by-email is enabled.
partition
Displays the administrative partition within which the component resides.
publish-irule-statistics
Enables or disables publishing analytics statistics for iRules.
sampling
Enables or disables transaction sampling. This attribute can be set in the default profile only. The
default value is disabled.
session-cookie-security
Specifies the condition for adding a secure attribute to the session cookie. The options are:
always
The secure attribute is always added to the session cookie.
never
The secure attribute is never added to the session cookie.
ssl-only
The secure attribute is only added to the session cookie when the virtual server has a client-SSL
profile. This is the default value.
session-timeout-minutes
Specifies the number of minutes of user non-activity before the system considers the session to be over.
smtp-config
Specifies the SMTP configuration to be used with analytics.
subnet-masks
Adds, deletes, or replaces predefined subnet addresses. This options defines the display names given to
certain subnet addresses seen in the client IP subnets report.
subnet
Subnet address. IPv4 addresses will be masked by 255.255.255.0. IPv6 addresses will be masked by
ffff:ffff:ffff:ffff:: .
countries-for-stat-collection
Manage a list of 10 predefined countries that are used for collecting AVR statistics
ips-for-stat-collection
Manage a list of 10 predefined IP addresses that are used for collecting AVR statistics.
subnets-for-stat-collection
Manage a list of 10 predefined URLs that are used for collecting AVR statistics.
urls-for-stat-collection
Manage a list of 10 predefined subnet addresses that are used for collecting AVR statistics. IPv4
addresses will be masked by 255.255.255.0. IPv6 addresses will be masked by ffff:ffff:ffff:ffff:: .
traffic-capture
Adds, deletes, or replaces an analytics traffic capture definition. You can configure the following
options for an analytics traffic capture:
app-service
Specifies the name of the application service to which the analytics traffic capture belongs. The
default value is none. Note: If the strict-updates option is enabled on the application service that
owns the object, you cannot modify or delete the analytics traffic capture. Only the application
service can modify or delete the analytics traffic capture.
captured-protocols
Specifies whether the system captures traffic data sent using all protocols, or only one type of
protocol.
The options are:
all Specifies that the system captures traffic data sent using all protocols.
http Specifies that the system captures traffic data sent using http protocol.
https
Specifies that the system captures traffic data sent using https protocol.
client-ips
Adds, deletes, or replaces a set of client IP addresses from/to which captured traffic is sent.
dos-activity
Specifies whether the system captures traffic data mitigated by DoS Layer 7 Enforcer or regardless
of DoS activity.
The options are:
any Specifies that system does not filter traffic data by DoS activity.
mitigated-by-dosl7
Specifies that the system captures only traffic data mitigated by DoS Layer 7 Enforcer.
methods
Adds, deletes, or replaces a set of HTTP methods used to send requests from which traffic is
captured.
name Specifies a unique name for an analytics traffic capture. This option is required for the commands
create, delete, and modify.
node-addresses
Adds, deletes, or replaces a set of node addresses from/to which captured traffic is sent.
request-captured-parts
Specifies what parts of the request data the system captures.
The options are:
all Specifies that the system captures all the parts of the request data.
body Specifies that the system captures the body of the request data.
headers
Specifies that the system captures the HTTP headers of the request data.
none Specifies that the system does not capture the request data.
request-content-filter-search-part
Specifies which part of the request is filtered by a specific string.
The options are:
all Specifies that the system filters all the parts of the request data.
body Specifies that the system filters the body of the request data.
headers
Specifies that the system filters the HTTP headers of the request data.
none Specifies that system does not filter the request data.
uri Specifies that the system filters the URI path component, including the query string, of the
request data.
request-content-filter-search-string
Specifies the string by which a request data is filtered, or none.
response-captured-parts
Specifies what parts of the response data the system captures.
The options are:
all Specifies that the system captures all the parts of the response data.
body Specifies that the system captures the body of the response data.
headers
Specifies that the system captures the HTTP headers of the response data.
none Specifies that the system does not capture the response data.
response-codes
Adds, deletes, or replaces a set of HTTP response codes from which traffic is captured.
response-content-filter-search-part
Specifies which part of the response is filtered by a specific string.
The options are:
all Specifies that the system filters all the parts of the response data.
body Specifies that the system filters the body of the response data.
headers
Specifies that the system filters the HTTP headers of the response data.
none Specifies that system does not filter the response data.
response-content-filter-search-string
Specifies the string by which the response data is filtered, or none.
url-path-prefixes
Adds, deletes, or replaces a set of URL path prefixes on which traffic can be captured (both to and
from).
user-agent-substrings
Adds, deletes, or replaces a set of user agent substrings on which traffic can be captured (both to
and from).
virtual-servers
Adds, deletes, or replaces a set of virtual servers from/to which captured traffic is sent.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, smtp, modify, regex, reset-stats, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2009-2013, 2017. All rights reserved.
BIG-IP 2017-11-20 ltm profile analytics(1)