Memory Statistics¶
Overview¶
Memory consumption information
Module Name in API¶
bigip-memory
Product Name in API¶
device
Dimensions¶
Dimension | Name in API | Description |
---|---|---|
BIG-IP Host Name | hostname | The hostname given to the BIG-IP |
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 |
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 |
MetricSets¶
System Free RAM¶
Description¶
Total free RAM on the BIG-IP
Name In API¶
free-ram
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Average System Free RAM | avg-value-per-event | bytes |
Other Total RAM¶
Description¶
Total RAM allocated for the Other, which are the non-TMM processes on the BIG-IP
Name In API¶
other-total-ram
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Other Total RAM | avg-value-per-event | bytes | Total Other RAM |
System Used RAM¶
Description¶
Total used RAM on the BIG-IP
Name In API¶
used-ram
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Average System Used RAM | avg-value-per-event | % |
TMM Total RAM¶
Description¶
Total RAM allocated for TMM on the BIG-IP
Name In API¶
tmm-total-ram
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Average TMM Total RAM | avg-value-per-event | bytes |
Swap Total¶
Description¶
Total Swap memory that exist on the BIG-IP
Name In API¶
total-swap
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Swap Size | avg-value-per-event | bytes |
System Total RAM¶
Description¶
Total RAM that exist on the BIG-IP
Name In API¶
total-ram
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Average System Total RAM | avg-value-per-event | bytes |
Other Free RAM¶
Description¶
Free RAM for the Other, which are the non-TMM processes on the BIG-IP
Name In API¶
other-free-ram
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Other Free RAM | avg-value-per-event | bytes | Total Other Free RAM |
TMM Used RAM¶
Description¶
Used RAM by the TMM on the BIG-IP
Name In API¶
tmm-used-ram
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Average TMM Used RAM | avg-value-per-event | % |
Other Used RAM¶
Description¶
Used RAM by the Other, which are the non-TMM processes on the BIG-IP
Name In API¶
other-used-ram
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Other Used RAM | avg-value-per-event | % | Total Other Used RAM |
Swap Used¶
Description¶
Used Swap memory on the BIG-IP
Name In API¶
used-swap
Metrics in the metricSet¶
Metric | Name in API | Unit | Description |
---|---|---|---|
Swap Used | 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 free-ram
{
"kind": "ap:query:stats:byTime",
"module": "bigip-memory",
"timeRange": {
"from": "-1h",
"to": "now"
},
"timeGranularity": {
"duration": 30,
"unit": "SECONDS"
},
"aggregations": {
"free-ram$avg-value-per-event": {
"metricSet": "free-ram",
"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 free-ram
{
"kind": "ap:query:stats:byEntities",
"module": "bigip-memory",
"timeRange": {
"from": "-1H",
"to": "now"
},
"dimension": "hostname",
"sortMetric": "free-ram$avg-value-per-event",
"sortOrder": "desc",
"aggregations": {
"free-ram$avg-value-per-event": {
"metricSet": "free-ram",
"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-memory",
"dimension": "hostname",
"timeRange": {
"from": "-1h",
"to": "now"
}
}