DNS Cache¶

Overview¶

Module Name in API¶

bigip-dns-cache

Product Name in API¶

dns

Dimensions¶

Dimension	Name in API	Description
BIG-IP Host Name	hostname	The hostname given to the BIG-IP
Sync Group	dns-sync-group
DNS Cache	dns-cache-name
BIG-IP Service Cluster	dsc-name	Clusters of BIG-IPs grouped together to have the same config

MetricSets¶

RPZ Rewrites¶

Description¶

Name In API¶

rpz-rewrites

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average RPZ Rewrites	avg-count-per-sec	rewrites/s

Cache Hit Ratio¶

Description¶

Name In API¶

dns-cache-hit-ratio

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Cache Hit Ratio	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/dns/metric-query

This example for JSON body in the post, filters by dimension hostname and get the avg-count-per-sec of rpz-rewrites

{
    "kind": "ap:query:stats:byTime",
    "module": "bigip-dns-cache",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "rpz-rewrites$avg-count-per-sec": {
                    "metricSet": "rpz-rewrites",
                    "metric": "avg-count-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/dns/metric-query

This example for JSON body in the post, gets top entities of type hostname, sorted by avg-count-per-sec of rpz-rewrites

{
    "kind": "ap:query:stats:byEntities",
    "module": "bigip-dns-cache",
    "timeRange": {
            "from": "-1H",
            "to": "now"
    },
    "dimension": "hostname",
    "sortMetric": "rpz-rewrites$avg-count-per-sec",
    "sortOrder": "desc",
    "aggregations": {
            "rpz-rewrites$avg-count-per-sec": {
                    "metricSet": "rpz-rewrites",
                    "metric": "avg-count-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/dns/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-dns-cache",
    "dimension": "hostname",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    }
}

Previous Next