DNS Zone¶

Overview¶

Module Name in API¶

bigip-dns-zone

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
BIG-IP Service Cluster	dsc-name	Clusters of BIG-IPs grouped together to have the same config
DNS Zone	dns-zone-name

MetricSets¶

TSIG Missing Zone Transfer¶

Description¶

Name In API¶

dns-zone-tsig-missing

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average TSIG Missing Zone Transfer	avg-count-per-sec	transfers/s

Responses¶

Description¶

Name In API¶

dns-zone-responses

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Responses	avg-count-per-sec	responses/s

Bad Signature Zone Transfer¶

Description¶

Name In API¶

dns-zone-tsig-bad-sig

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Bad Signature Zone Transfer	avg-count-per-sec	transfers/s

Queries¶

Description¶

Name In API¶

dns-zone-queries

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Queries	avg-count-per-sec	queries/s

Requests By Query Type CNAME¶

Description¶

Name In API¶

requests-by-q-cname

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type CNAME	avg-count-per-sec	DNS rps

Requests By Query Type SRV¶

Description¶

Name In API¶

requests-by-q-srv

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type SRV	avg-count-per-sec	DNS rps

Requests By Query Type A¶

Description¶

Name In API¶

requests-by-q-a

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type A	avg-count-per-sec	DNS rps

Requests By Query Type ANY¶

Description¶

Name In API¶

requests-by-q-any

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type ANY	avg-count-per-sec	DNS rps

Verified Zone Transfer¶

Description¶

Name In API¶

dns-zone-tsig-verified

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Verified Zone Transfer	avg-count-per-sec	transfers/s

No TSIG Zone Transfer¶

Description¶

Name In API¶

dns-zone-tsig-not-required

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average No TSIG Zone Transfer	avg-count-per-sec	transfers/s

Requests By Query Type NS¶

Description¶

Name In API¶

requests-by-q-ns

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type NS	avg-count-per-sec	DNS rps

Requests By Query Type OTHER¶

Description¶

Name In API¶

requests-by-q-other

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type OTHER	avg-count-per-sec	DNS rps

Requests By Query Type TXT¶

Description¶

Name In API¶

requests-by-q-txt

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type TXT	avg-count-per-sec	DNS rps

Bad Key Zone Transfer¶

Description¶

Name In API¶

dns-zone-tsig-bad-key

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Bad Key Zone Transfer	avg-count-per-sec	transfers/s

Requests By Query Type MX¶

Description¶

Name In API¶

requests-by-q-mx

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type MX	avg-count-per-sec	DNS rps

Requests By Query Type AAAA¶

Description¶

Name In API¶

requests-by-q-aaaa

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type AAAA	avg-count-per-sec	DNS rps

Requests By Query Type AXFR¶

Description¶

Name In API¶

requests-by-q-axfr

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type AXFR	avg-count-per-sec	DNS rps

Requests By Query Type SOA¶

Description¶

Name In API¶

requests-by-q-soa

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type SOA	avg-count-per-sec	DNS rps

Requests By Query Type IXFR¶

Description¶

Name In API¶

requests-by-q-ixfr

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Requests By Query Type IXFR	avg-count-per-sec	DNS rps

Bad Time Zone Transfer¶

Description¶

Name In API¶

dns-zone-tsig-bad-time

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Bad Time Zone Transfer	avg-count-per-sec	transfers/s

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 dns-zone-tsig-missing

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

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

Previous Next