analytics tcp-analytics report

analytics tcp-analytics reportBIG-IP TMSH Mananalytics tcp-analytics report(1)



NAME
       report - Displays the TCP analytics report.

MODULE
       analytics tcp analytics

SYNTAX
       Show, save or send an analytics tcp-analytics report using the syntax
       shown in the following sections.

   DISPLAY
	show report view-by [ application | city-postcode | continent-code |
	country-region | nexthop | remote-address | request-side | subnet | user-key | virtual ]
	 options:
	  drilldown {
	    {
		entity [  application | city-postcode | continent-code | country-region | nexthop | remote-address | request-side | subnet | user-key | virtual  ]
		values
		{
		  [value ...]
		}
	    } ...
	  }
	  field-fmt
	  include-total
	  include-others
	  limit [number of rows]
	  measures {
	    [measure name ...]
	  }
	  order-by {
	    {
	      measure [ measure name ]
	      sort-type [ asc / desc ]
	    } ...
	  }
	  range [date range]

   SAVE
	save report view-by [ application | city-postcode | continent-code |
	country-region | nexthop | remote-address | request-side | subnet | user-key | virtual ]
	 options:
	   drilldown {
	    {
		entity [ application | city-postcode | continent-code | country-region | nexthop | remote-address | request-side | subnet | user-key | virtual ]
		values
		{
		  [value ...]
		}
	    } ...
	  }
	  file [ file name ]
	  format [ csv-aggregated | csv-time-series | pdf ]
	  include-total
	  include-others
	  limit [number of rows]
	  measures {
	    [measure name ...]
	  }
	  order-by {
	    {
	      measure [ measure name ]
	      sort-type [ asc / desc ]
	    } ...
	  }
	  range [date range]

   SEND
	send-mail report view-by [  application | city-postcode | continent-code |
	country-region | nexthop | remote-address | request-side | subnet | user-key | virtual ]
	 options:
	  drilldown {
	    {
		entity [ application | city-postcode | continent-code | country-region | nexthop | remote-address | request-side | subnet | user-key | virtual ]
		values
		{
		  [value ...]
		}
	    } ...
	  }
	  email-addresses {
	     [email address ...]
	  }
	  format [ csv-aggregated | csv-time-series | pdf ]
	  include-total
	  include-others
	  limit [number of rows]
	  measures {
	    [measure name ...]
	  }
	  order-by {
	    {
	      measure [ measure name ]
	      sort-type [ asc / desc ]
	    } ...
	  }
	  range [date range]
	  smtp-config-override [ smtp configuration object name ]

DESCRIPTION
       Use this command to generate tcp analytics reports. You can generate a
       TCP analytics report for the following entities:

       o    application - Application services

       o    city-postcode - City and postcode of remote host

       o    continent-code - Continent of remote host

       o    country-region - Country and region of remote host

       o    nexthop - MAC address of next routing hop

       o    remote-address - IP address of remote host

       o    request-side - Client-side or server-side connection

       o    subnet - /24 subnet of remote host

       o    user-key - Key user-defined by TCP::analytics iRule.

       o    virtual - Virtual Server

       Different measures are collected for each of these entities and can be
       a part of the report request.

EXAMPLES
       show analytics tcp-analytics report view-by virtual

       show analytics tcp-analytics report view-by virtual drilldown { {
       entity remote-address values { 10.10.2.2 } } }

       send-mail analytics tcp-analytics report view-by remote-address
       measures { goodput-rcv } limit 20 order-by { { measure goodput-rcv
       sort-type desc } } format pdf email-addresses {
       some.one@someaddress.com }

       For more syntactical examples, see the tmsh help manual for analytics
       report.

OPTIONS
       device
	    Specifies a BIG-IP device on which to generate a report.
	    (Enterprise Manager only)

       device-list
	    Specifies a custom list of BIG-IP devices on which to generate a
	    report. (Enterprise Manager only)

       drilldown
	    Specifies specific entities that are used as a filter.

       email-addresses
	    Specifies the list of email addresses to which the report file is
	    sent when using the send-mail command.

       file Specifies the exported file path to be saved when using the save
	    command. The file name should be simple (not a full path).

       format
	    Specifies the exported file format to be saved or sent. This
	    option must be specified when using the save or send-mail
	    commands.

       include-others
	    Specifies that the grand total for the measure is displayed for
	    all entities, except for those shown in the result. It can be used
	    along with include-total.

       include-total
	    Specifies that a total summary row should be added to the
	    analytics report. For average measures, the total value is also an
	    average.

       limit
	    Specifies the maximum number of rows/entities in the output result
	    set/file. The default value is 10, not including the total
	    row/entity. The maximum value is 1000.

       measures
	    Specifies a list of measures that can be used with the chosen
	    entity type. The options are:

	    avg-connection-goodput-received
		 The mean incoming goodput (in bits per second) of all TCP
		 connections for the selected filter (entity).

	    avg-connection-goodput-sent
		 The mean outgoing goodput (in bits per second) of all TCP
		 connections for the selected filter (entity).

	    connections-closed
		 The total number of connections ended for the selected filter
		 (entity).

	    connections-length-mean
		 The mean connection length (in ms) for the selected filter
		 (entity).

	    connections-opened
		 The total number connections started for the selected filter
		 (entity).

	    delaystate-3whs
		 Time (in ms) spent by the connection in delay state three-way
		 handshake (3WHS) for the selected filter (entity).

	    delaystate-app
		 Time (in ms) spent by the connection in delay state limited
		 by lack of application data for the selected filter (entity).

	    delaystate-closing
		 Time (in ms) spent by the connection in delay state waiting
		 for ack of FIN for the selected filter (entity).

	    delaystate-cwnd
		 Time (in ms) spent by the connection in delay state limited
		 by the congestion window for the selected filter (entity).

	    delaystate-nagle
		 Time (in ms) spent by the connection in delay state where the
		 app is limited, last packet held due to Nagle algorithm for
		 the selected filter (entity).

	    delaystate-ratepace
		 Time (in ms) spent by the connection in delay state where the
		 app is limited, transmission delayed by rate pacing for the
		 selected filter (entity).

	    delaystate-retx
		 Time (in ms) spent by the connection in delay state
		 retransmitting lost packets for the selected filter (entity).

	    delaystate-rwnd
		 Time (in ms) spent by the connection in delay state where the
		 client receive window is limited for the selected filter
		 (entity).

	    delaystate-sndbuf
		 Time (in ms) spent by the connection in delay state limited
		 by send buffer configuration for the selected filter
		 (entity).

	    delaystate-waitforack
		 Time (in ms) spent by the connection in delay state waiting
		 for acknowledgement for the selected filter (entity).

	    goodput-received
		 The aggregate data rate (in bits per second) received over
		 all connections for the selected filter (entity).

	    goodput-sent
		 The aggregate data rate (in bits per second) sent over all
		 connections for the selected filter (entity).

	    max-connection-goodput-received
		 The maximum incoming goodput (in bits per second) on any TCP
		 connection for the selected filter (entity).

	    max-connection-goodput-sent
		 The maximum outgoing goodput (in bits per second) on any TCP
		 connection for the selected filter (entity).

	    min-connection-goodput-received
		 The minimum incoming goodput (in bits per second) on any TCP
		 connection for the selected filter (entity).

	    min-connection-goodput-sent
		 The minimum outgoing goodput (in bits per second) on any TCP
		 connection for the selected filter (entity).

	    packet-loss-rate
		 The fraction of sent packets that are lost for the selected
		 filter (entity).

	    packets-lost
		 The total number of sent packets lost for the selected filter
		 (entity).

	    packets-received
		 The total number of packets received for the selected filter
		 (entity).

	    packets-sent
		 The total number of packets sent for the selected filter
		 (entity).

	    rtt-avg
		 The mean round trip time (in ms) for the selected filter
		 (entity).

	    rtt-max
		 The maximum round trip time in ms for the selected filter
		 (entity).

	    rtt-min
		 The minimum round trip time (in ms) for the selected filter
		 (entity).

	    rttvar-mean
		 The mean variance of the round trip time (in ms) for the
		 selected filter (entity).

SEE ALSO
       show, save, send-mail, tmsh, ltm profile analytics, analytics,
       analytics report

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 2008-2015. All rights reserved.



BIG-IP				  2017-06-14 analytics tcp-analytics report(1)