CPU Statistics¶
Overview¶
CPU consumption information
Module Name in API¶
bigip-cpu
Product Name in API¶
device
Dimensions¶
Dimension | Name in API | Description |
---|---|---|
BIG-IP Host Name | hostname | The hostname given to the BIG-IP |
Service Scaling Group | ssg | The name of the Service Scaling Group |
BIG-IP Blade | hostname-slot | This is a combination of a BIG-IP hostname and its blade number |
SSG and BIG-IP Blade | ssg-hostname-slot | |
BIG-IP Service Cluster | dsc-name | Clusters of BIG-IPs grouped together to have the same config |
BIG-IP CPU Core | hostname-slot-cpu-core | This is a combination of a BIG-IP hostname, its blade number and cpu core number |
MetricSets¶
CPU User¶
Description¶
CPU usage of User criteria (user + nice)
Name In API¶
cpu-usage
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Average CPU User | avg-value-per-event | % |
CPU System¶
Description¶
CPU usage of System criteria
Name In API¶
cpu-system
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Average CPU System | avg-value-per-event | % |
CPU Stolen¶
Description¶
CPU usage of stolen criteria
Name In API¶
cpu-stolen
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Average CPU Stolen | avg-value-per-event | % |
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/device/metric-query
This example for JSON body in the post, filters by dimension hostname and get the avg-value-per-event of cpu-usage
{
"kind": "ap:query:stats:byTime",
"module": "bigip-cpu",
"timeRange": {
"from": "-1h",
"to": "now"
},
"timeGranularity": {
"duration": 30,
"unit": "SECONDS"
},
"aggregations": {
"cpu-usage$avg-value-per-event": {
"metricSet": "cpu-usage",
"metric": "avg-value-per-event"
}
},
"dimensionFilter": {
"type": "eq",
"dimension": "hostname",
"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/device/metric-query
This example for JSON body in the post, gets top entities of type hostname, sorted by avg-value-per-event of cpu-usage
{
"kind": "ap:query:stats:byEntities",
"module": "bigip-cpu",
"timeRange": {
"from": "-1H",
"to": "now"
},
"dimension": "hostname",
"sortMetric": "cpu-usage$avg-value-per-event",
"sortOrder": "desc",
"aggregations": {
"cpu-usage$avg-value-per-event": {
"metricSet": "cpu-usage",
"metric": "avg-value-per-event"
}
},
"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/device/metric-query
This example for JSON body in the post, gets the distinct count of entities of type hostname
{
"kind": "ap:query:stats:entitiesCount",
"module": "bigip-cpu",
"dimension": "hostname",
"timeRange": {
"from": "-1h",
"to": "now"
}
}