Disk Usage

Overview

Module Name in API

bigip-disk-usage

Product Name in API

device

Dimensions

Dimension Name in API Description
BIG-IP Host Name hostname The hostname given to the BIG-IP
Partition partition  
BIG-IP Service Cluster dsc-name Clusters of BIG-IPs grouped together to have the same config

MetricSets

Disk Available Size

Description

Amount of data available in disk storage

Name In API

disk-available-size

Metrics in the metricSet

Metric Name in API Unit Description
Average Available Bytes avg-value-per-event bytes  

Disk Used Size

Description

Amount of data used in disk storage

Name In API

disk-used-size

Metrics in the metricSet

Metric Name in API Unit Description
Average Used Bytes avg-value-per-event bytes  

Disk Used Ratio

Description

Percentage of the used disk storage out of total size

Name In API

disk-used-ratio

Metrics in the metricSet

Metric Name in API Unit Description
Average Usage % 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 disk-available-size

{
    "kind": "ap:query:stats:byTime",
    "module": "bigip-disk-usage",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "disk-available-size$avg-value-per-event": {
                    "metricSet": "disk-available-size",
                    "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 disk-available-size

{
    "kind": "ap:query:stats:byEntities",
    "module": "bigip-disk-usage",
    "timeRange": {
            "from": "-1H",
            "to": "now"
    },
    "dimension": "hostname",
    "sortMetric": "disk-available-size$avg-value-per-event",
    "sortOrder": "desc",
    "aggregations": {
            "disk-available-size$avg-value-per-event": {
                    "metricSet": "disk-available-size",
                    "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-disk-usage",
    "dimension": "hostname",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    }
}