Disk¶

Overview¶

Module Name in API¶

bigip-disk

Product Name in API¶

device

Dimensions¶

Dimension	Name in API	Description
BIG-IP Host Name	hostname	The hostname given to the BIG-IP
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¶

Write Bytes¶

Description¶

Disk write volume by bytes

Name In API¶

wr-bytes

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Write Bytes	avg-value-per-sec	Bps

Read Ops¶

Description¶

Disk read operations

Name In API¶

rd-ops

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Read Ops	avg-value-per-sec	Ops

Read Merges¶

Description¶

Disk read merge operations

Name In API¶

rd-merged

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Read Merges	avg-value-per-sec	merges/s

Write Merges¶

Description¶

Disk write merge operations

Name In API¶

wr-merged

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Write Merges	avg-value-per-sec	merges/s

Read Bytes¶

Description¶

Disk read volume by bytes

Name In API¶

rd-bytes

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Read Bytes	avg-value-per-sec	Bps

Write Ops¶

Description¶

Disk write operations

Name In API¶

wr-ops

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Write Ops	avg-value-per-sec	Ops

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-sec of wr-bytes

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

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

Previous Next