Health¶
Overview¶
Module Name in API¶
bigip-health
Product Name in API¶
device
Dimensions¶
| Dimension | Name in API | Description |
|---|---|---|
| Application Service | applicationService | |
| Health | applicationHealth | |
| Application | applications |
MetricSets¶
Total connections health score¶
Description¶
Name In API¶
total-connections-health-score
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Total Connections Health Score | avg-value-per-event | % |
CPU health score¶
Description¶
Name In API¶
cpu-health-score
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average CPU Health Score | avg-value-per-event | % |
TMM memory health score¶
Description¶
Name In API¶
tmm-memory-health-score
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average TMM Memory Health Score | avg-value-per-event | % |
Application health score¶
Description¶
Name In API¶
application-health-score
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Application Health Score | avg-value-per-event | % |
Server health score¶
Description¶
Name In API¶
server-health-score
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Server Health Score | avg-value-per-event | % |
Server latency health score¶
Description¶
Name In API¶
server-latency-health-score
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Server Latency | avg-value-per-event | % |
Network health score¶
Description¶
Name In API¶
network-health-score
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Network Health Score | avg-value-per-event | % |
Incomplete Transactions¶
Description¶
Name In API¶
server-incomplete-percent
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Incomplete Transactions | 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 applicationService and get the avg-value-per-event of total-connections-health-score
{
"kind": "ap:query:stats:byTime",
"module": "bigip-health",
"timeRange": {
"from": "-1h",
"to": "now"
},
"timeGranularity": {
"duration": 30,
"unit": "SECONDS"
},
"aggregations": {
"total-connections-health-score$avg-value-per-event": {
"metricSet": "total-connections-health-score",
"metric": "avg-value-per-event"
}
},
"dimensionFilter": {
"type": "eq",
"dimension": "applicationService",
"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 applicationService, sorted by avg-value-per-event of total-connections-health-score
{
"kind": "ap:query:stats:byEntities",
"module": "bigip-health",
"timeRange": {
"from": "-1H",
"to": "now"
},
"dimension": "applicationService",
"sortMetric": "total-connections-health-score$avg-value-per-event",
"sortOrder": "desc",
"aggregations": {
"total-connections-health-score$avg-value-per-event": {
"metricSet": "total-connections-health-score",
"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 applicationService
{
"kind": "ap:query:stats:entitiesCount",
"module": "bigip-health",
"dimension": "applicationService",
"timeRange": {
"from": "-1h",
"to": "now"
}
}