TCP Application Service Summary¶
Overview¶
A summary overview for an TCP application service, managed by the BIG-IP devices that are connected to BIG-IQ centralized management.
REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/TcpApplicationServiceSummary¶
Requests¶
GET /mgmt/ap/query/v1/tenants/default/reports/TcpApplicationServiceSummary¶
Query Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| $appService | string | True | Specifies the application service name. |
| $from | string | False | Specifies time to start results. The default uses the values of “-5m” for from and “now” for to, which starts from 5 minutes before the current time and ends at the current time. |
| $to | string | False | Specifies time to end results. The default uses the values of “-5m” for from and “now” for to, which starts from 5 minutes before the current time and ends at the current time. |
| $securityFrom | string | False | Specifies the earliest application service security data shown over the elapsed time period. The default uses the values of “-1d” for securityFrom and “now” for to, which starts from 1 day before the current time and ends at the current time. |
| $from-TS | string | False | Specify time to start results for sparklines. The default uses the values of “-1h” for from-TS and “now” for to, which starts from 1 hour before the current time and ends at the current time. |
| $resolution-minutes-TS | string | False | Data values shown according to time increments in minutes. The default value is 5 minutes. |
Response¶
HTTP/1.1 200 OK
| Name | Type | Description |
|---|---|---|
| health | HealthEnum | The application service’s health. Possible values “Critical”, “Moderate”, “Good” or “Other”. |
| throughputStats | object | The current average of throughput statistics. |
| throughputIn | number | The application service’s incoming throughput. |
| throughputOut | number | The application service’s outgoing throughput. |
| throughputStatsTs | object | The application service’s throughput statistics over time. |
| timeMillis | number | The end time of the specific time slot within the time period. |
| count | number | The number of data samples collected in the specific time slot. |
| throughputIn | number | The avarage incoming throughput for the specific time slot. |
| throughputOut | number | The avarage outgoing throughput for the specific time slot. |
| goodputStats | object | The current average of goodput statistics. |
| goodputIn | number | The application service’s incoming goodput. |
| goodputOut | number | The application service’s outgoing goodput. |
| goodputStatsTs | object | The application service’s goodputput statistics over time. |
| timeMillis | number | The end time of the specific time slot within the time period. |
| count | number | The number of data samples collected in the specific time slot. |
| goodputIn | number | The avarage incoming goodput for the specific time slot. |
| goodputOut | number | The avarage outgoing goodput for the specific time slot. |
| rtt | number | The current average of round-trip time statistics. |
| rttTs | object | The application service’s round-trip time statistics over time. |
| timeMillis | number | The end time of the specific time slot within the time period. |
| count | number | The number of data samples collected in the specific time slot. |
| rtt | number | The avarage round-trip time for the specific time slot. |
| connectionsLength | number | The current average of connections length statistics. |
| connectionsLengthTs | object | The application service’s connections length statistics over time. |
| timeMillis | number | The end time of the specific time slot within the time period. |
| count | number | The number of data samples collected in the specific time slot. |
| connectionsLength | number | The avarage connections length for the specific time slot. |
| newConnections | double | The current average of new connections statistics. |
| newConnectionsTs | object | The application service’s number of new connections statistics over time. |
| timeMillis | number | The end time of the specific time slot within the time period. |
| count | number | The number of data samples collected in the specific time slot. |
| newConnections | number | The avarage number of new connections for the specific time slot. |
| delayStates | object | The application service’s current time distribution in the different TCP delay states. |
| RETX | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to retransmission of data. |
| APP | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to application level. |
| CLOSING | number | The percentage of time out of all delay states that a connection was waiting for ACK for the FIN request. |
| NAGLE | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to Nagle’s algorithm, holding sub-MSS size packets. |
| CWND | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to limited congestion-window. |
| 3WHS | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to 3-way handshake that starts a TCP connection. |
| SNDBUF | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to full send buffer. |
| WAITFORACK | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to wait for ack. |
| RWND | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to limited receive window. |
| RATEPACE | number | The percentage of time out of all delay states that outgoing data delivery was delayed due to rate pacing. |
| alertsHistory | object | Summary of the application service’s active alerts history. |
| id | string | The alert’s unique identifier. |
| title | string | A short description of the alert. |
| startTime | number | The time in which the alert was raised. |
| timestamp | number | The time in which the alert was updated. |
| severity | string | The severity of the alert. |
| severityLevel | number | The severity’s numeric value. |
| activeAlerts | object | Summary of the application service’s active alerts. |
| id | string | The alert’s unique identifier. |
| title | string | A short description of the alert. |
| severity | string | The severity of the alert. |
| severityLevel | number | The severity’s numeric value. |
Permissions¶
| Role | Allow |
|---|---|
| Application Viewer | Yes |
| Application Manager | Yes |
| Application Creator | Yes |
| Application Editor | Yes |
Examples¶
GET to retrieve summary of a single specified application¶
Following is an example of a response to the default API call, with only the required $appService parameter.
GET https://<BIG-IQ>/mgmt/ap/query/v1/tenants/default/reports/TcpApplicationServiceSummary?$appService=tcp_legacy
Response¶
{
"kind": "ap:compose:Report",
"lastUpdateMicros": 2922952660,
"result": {
"throughputStatsTs": [
{
"timeMillis": 1584817500000,
"count": 0,
"throughputIn": 0.0,
"throughputOut": 0.0
},
{
"timeMillis": 1584817800000,
"count": 0,
"throughputIn": 0.0,
"throughputOut": 0.0
},
{
"timeMillis": 1584818100000,
"count": 0,
"throughputIn": 0.0,
"throughputOut": 0.0
},
{
"timeMillis": 1584818400000,
"count": 0,
"throughputIn": 0.0,
"throughputOut": 0.0
},
{
"timeMillis": 1584818700000,
"count": 0,
"throughputIn": 0.0,
"throughputOut": 0.0
},
{
"timeMillis": 1584819000000,
"count": 0,
"throughputIn": 7959.12,
"throughputOut": 23465.42
},
{
"timeMillis": 1584819300000,
"count": 0,
"throughputIn": 7879.733333333334,
"throughputOut": 23216.01
},
{
"timeMillis": 1584819600000,
"count": 0,
"throughputIn": 7829.986666666667,
"throughputOut": 23037.32
},
{
"timeMillis": 1584819900000,
"count": 0,
"throughputIn": 7847.493333333333,
"throughputOut": 23180.77
},
{
"timeMillis": 1584820200000,
"count": 0,
"throughputIn": 7829.986666666667,
"throughputOut": 23021.0
},
{
"timeMillis": 1584820500000,
"count": 0,
"throughputIn": 7795.493333333333,
"throughputOut": 22964.0
},
{
"timeMillis": 1584820800000,
"count": 0,
"throughputIn": 7822.013333333333,
"throughputOut": 23029.87
},
{
"timeMillis": 1584821100000,
"count": 0,
"throughputIn": 4882.8,
"throughputOut": 14374.97
}
],
"goodputStatsTs": [
{
"timeMillis": 1584817500000,
"count": 0,
"goodputIn": 0.0,
"goodputOut": 0.0
},
{
"timeMillis": 1584817800000,
"count": 0,
"goodputIn": 0.0,
"goodputOut": 0.0
},
{
"timeMillis": 1584818100000,
"count": 0,
"goodputIn": 0.0,
"goodputOut": 0.0
},
{
"timeMillis": 1584818400000,
"count": 0,
"goodputIn": 0.0,
"goodputOut": 0.0
},
{
"timeMillis": 1584818700000,
"count": 0,
"goodputIn": 0.0,
"goodputOut": 0.0
},
{
"timeMillis": 1584819000000,
"count": 0,
"goodputIn": 1674.22,
"goodputOut": 18486.783333333333
},
{
"timeMillis": 1584819300000,
"count": 0,
"goodputIn": 1660.64,
"goodputOut": 18233.8
},
{
"timeMillis": 1584819600000,
"count": 0,
"goodputIn": 1656.76,
"goodputOut": 18150.233333333334
},
{
"timeMillis": 1584819900000,
"count": 0,
"goodputIn": 1652.88,
"goodputOut": 18214.133333333335
},
{
"timeMillis": 1584820200000,
"count": 0,
"goodputIn": 1649.0,
"goodputOut": 18046.3
},
{
"timeMillis": 1584820500000,
"count": 0,
"goodputIn": 1649.0,
"goodputOut": 18093.7
},
{
"timeMillis": 1584820800000,
"count": 0,
"goodputIn": 1652.88,
"goodputOut": 18124.6
},
{
"timeMillis": 1584820980000,
"count": 0,
"goodputIn": 1649.0,
"goodputOut": 18170.944444444445
}
],
"rttTs": [
{
"timeMillis": 1584817500000,
"count": 0,
"rtt": 0.0
},
{
"timeMillis": 1584817800000,
"count": 0,
"rtt": 0.0
},
{
"timeMillis": 1584818100000,
"count": 0,
"rtt": 0.0
},
{
"timeMillis": 1584818400000,
"count": 0,
"rtt": 0.0
},
{
"timeMillis": 1584818700000,
"count": 0,
"rtt": 0.0
},
{
"timeMillis": 1584819000000,
"count": 0,
"rtt": 1.4816733067729084
},
{
"timeMillis": 1584819300000,
"count": 0,
"rtt": 1.4821573398215735
},
{
"timeMillis": 1584819600000,
"count": 0,
"rtt": 1.487157316514928
},
{
"timeMillis": 1584819900000,
"count": 0,
"rtt": 1.4834181078331639
},
{
"timeMillis": 1584820200000,
"count": 0,
"rtt": 1.4855624265344713
},
{
"timeMillis": 1584820500000,
"count": 0,
"rtt": 1.487385086823289
},
{
"timeMillis": 1584820800000,
"count": 0,
"rtt": 1.486315682177259
},
{
"timeMillis": 1584820980000,
"count": 0,
"rtt": 1.4920728622027324
}
],
"newConnectionsTs": [
{
"timeMillis": 1584817500000,
"count": 0,
"newConnections": 0.0
},
{
"timeMillis": 1584817800000,
"count": 0,
"newConnections": 0.0
},
{
"timeMillis": 1584818100000,
"count": 0,
"newConnections": 0.0
},
{
"timeMillis": 1584818400000,
"count": 0,
"newConnections": 0.0
},
{
"timeMillis": 1584818700000,
"count": 0,
"newConnections": 0.0
},
{
"timeMillis": 1584819000000,
"count": 0,
"newConnections": 17.273333333333333
},
{
"timeMillis": 1584819300000,
"count": 0,
"newConnections": 17.106666666666666
},
{
"timeMillis": 1584819600000,
"count": 0,
"newConnections": 17.08
},
{
"timeMillis": 1584819900000,
"count": 0,
"newConnections": 17.04
},
{
"timeMillis": 1584820200000,
"count": 0,
"newConnections": 17.0
},
{
"timeMillis": 1584820500000,
"count": 0,
"newConnections": 17.0
},
{
"timeMillis": 1584820800000,
"count": 0,
"newConnections": 17.04
},
{
"timeMillis": 1584820980000,
"count": 0,
"newConnections": 17.0
}
],
"connectionsLengthTs": [
{
"timeMillis": 1584817500000,
"count": 0,
"connectionsLength": 0.0
},
{
"timeMillis": 1584817800000,
"count": 0,
"connectionsLength": 0.0
},
{
"timeMillis": 1584818100000,
"count": 0,
"connectionsLength": 0.0
},
{
"timeMillis": 1584818400000,
"count": 0,
"connectionsLength": 0.0
},
{
"timeMillis": 1584818700000,
"count": 0,
"connectionsLength": 0.0
},
{
"timeMillis": 1584819000000,
"count": 0,
"connectionsLength": 9.966036279428792
},
{
"timeMillis": 1584819300000,
"count": 0,
"connectionsLength": 10.343457943925234
},
{
"timeMillis": 1584819600000,
"count": 0,
"connectionsLength": 10.255854800936769
},
{
"timeMillis": 1584819900000,
"count": 0,
"connectionsLength": 10.116392801251957
},
{
"timeMillis": 1584820200000,
"count": 0,
"connectionsLength": 10.14095275436189
},
{
"timeMillis": 1584820500000,
"count": 0,
"connectionsLength": 10.062745098039215
},
{
"timeMillis": 1584820800000,
"count": 0,
"connectionsLength": 10.125978090766823
},
{
"timeMillis": 1584820980000,
"count": 0,
"connectionsLength": 10.217107411034933
}
],
"throughputStats": {
"throughputIn": 5840.230303030303,
"throughputOut": 17256.02727272727
},
"goodputStats": {
"goodputIn": 1651.425,
"goodputOut": 18184.770833333332
},
"rtt": 1.4864433811802233,
"newConnections": 17.025,
"connectionsLength": 10.210075813157252,
"delayStates": {
"RETX": 0.0,
"APP": 78.88499415790352,
"CLOSING": 3.832832582206643,
"NAGLE": 0.0,
"CWND": 0.0,
"3WHS": 12.892255049240527,
"SNDBUF": 0.0,
"WAITFORACK": 4.3899182106493075,
"RWND": 0.0,
"RATEPACE": 0.0
},
"health": "Moderate",
"activeAlerts": [
{
"id": "GUID value",
"title": "Application Service Health: Moderate (tcp_legacy)",
"timestamp": 1584818821019,
"severity": "Warning"
}
],
"alertsHistory": [
{
"id": "GUID value",
"title": "Application Service Health: Moderate (tcp_legacy)",
"timestamp": 1584818821019,
"severity": "Warning"
},
{
"id": "GUID value",
"title": "Application Service Health: Good (tcp_legacy)",
"timestamp": 1584818521339,
"severity": "Cleared"
},
{
"id": "GUID value",
"title": "Application Service Health: Moderate (tcp_legacy)",
"timestamp": 1584749580640,
"severity": "Warning"
},
{
"id": "GUID value",
"title": "Application Service Health: Good (tcp_legacy)",
"timestamp": 1584749520924,
"severity": "Cleared"
},
{
"id": "GUID value",
"title": "Application Service Health: Moderate (tcp_legacy)",
"timestamp": 1584735180629,
"severity": "Warning"
}
]
},
"requestDurationInMillis": 48
}