SWG¶
Overview¶
Module Name in API¶
bigip-swg
Product Name in API¶
local-traffic
Dimensions¶
Dimension | Name in API | Description |
---|---|---|
SSL Bypass | ssl-bypass | |
BIG-IP Blade Number | slot-id | Used for BIG-IP Chassis with multiple blades. A value of 0 means this is a non chassis BIG-IP, any other value tells the serial number of the blade in the chassis |
Domain Name | query-name | |
Client IP | client-ip | |
Serving Application | serving-application-name | |
Serving Application Family | serving-application-family | |
Risk Class | risk-class | |
URL | url | |
User Name | client-user-name | |
User Group | client-user-group | |
BIG-IP Host Name | hostname | The hostname given to the BIG-IP |
URL Category | url-category | |
BIG-IP Service Cluster | dsc-name | Clusters of BIG-IPs grouped together to have the same config |
URL Filter | url-filter | |
Action | security-action | The action a security module took with this transaction/packet, such as allow or block |
MetricSets¶
Transactions¶
Description¶
Number of transactions
Name In API¶
transactions
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Total Transactions Count | count | trans | Total number of transactions that passed through the system |
Avg TPS | avg-count-per-sec | tps | Average number of transactions that passed through the system per second |
Examples¶
By Time Query¶
A query by time returns a series of data points in time, based on optional filters, time range, and time granularity. This query kind is identified by the keyword: “ap:query:stats:byTime”
POST https://<address>/mgmt/ap/query/v1/tenants/default/products/local-traffic/metric-query
This example for JSON body in the post, filters by dimension ssl-bypass and get the count of transactions
{
"kind": "ap:query:stats:byTime",
"module": "bigip-swg",
"timeRange": {
"from": "-1h",
"to": "now"
},
"timeGranularity": {
"duration": 30,
"unit": "SECONDS"
},
"aggregations": {
"transactions$count": {
"metricSet": "transactions",
"metric": "count"
}
},
"dimensionFilter": {
"type": "eq",
"dimension": "ssl-bypass",
"value": "value to filter by"
}
}
By Entities Query¶
A query by entities returns a sort set of entities, based on optional filters, time range, and choosen metric to sort by. This query kind is identified by the keyword: “ap:query:stats:byEntities”
POST https://<address>/mgmt/ap/query/v1/tenants/default/products/local-traffic/metric-query
This example for JSON body in the post, gets top entities of type ssl-bypass, sorted by count of transactions
{
"kind": "ap:query:stats:byEntities",
"module": "bigip-swg",
"timeRange": {
"from": "-1H",
"to": "now"
},
"dimension": "ssl-bypass",
"sortMetric": "transactions$count",
"sortOrder": "desc",
"aggregations": {
"transactions$count": {
"metricSet": "transactions",
"metric": "count"
}
},
"limit": 5
}
Entities Count Query¶
An entities count query returns the distinct count of entities, based on optional filters, time range, and choosen entity type. This query kind is identified by the keyword: “ap:query:stats:entitiesCount”
POST https://<address>/mgmt/ap/query/v1/tenants/default/products/local-traffic/metric-query
This example for JSON body in the post, gets the distinct count of entities of type ssl-bypass
{
"kind": "ap:query:stats:entitiesCount",
"module": "bigip-swg",
"dimension": "ssl-bypass",
"timeRange": {
"from": "-1h",
"to": "now"
}
}