DNS Profile¶

Overview¶

Module Name in API¶

bigip-dns-profile

Product Name in API¶

dns

Dimensions¶

Dimension	Name in API	Description
Profile Name	profile-name
BIG-IP Host Name	hostname	The hostname given to the BIG-IP
Listener	dns-listener
Sync Group	dns-sync-group
DataCenter Name	datacenter-name
DataCenter	datacenter
BIG-IP Service Cluster	dsc-name	Clusters of BIG-IPs grouped together to have the same config
DataCenter Location	datacenter-location

MetricSets¶

HW Improperly Formatted¶

Description¶

Name In API¶

dns-profile-hw-malformed

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Improperly Formatted Hardware Handled Packets	avg-count-per-sec	packets/s

Rapid Refused¶

Description¶

Name In API¶

dns-profile-fast-refused

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Rapid Responses With Last Action: Refused	avg-count-per-sec	DNS rps

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

Recursion Available Responses¶

Description¶

Name In API¶

dns-profile-responses-recursion-available

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Recursion Available Responses	avg-count-per-sec	DNS rps

Rapid Responses¶

Description¶

Name In API¶

dns-profile-fast-responses

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Rapid Responses	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

Total Rejects¶

Description¶

Name In API¶

rejects-total

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Total Rejects	avg-count-per-sec	DNS rps

Rapid Dropped¶

Description¶

Name In API¶

dns-profile-fast-drops

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Rapid Responses With Last Action: Dropped	avg-count-per-sec	DNS rps

Nonexistent Responses¶

Description¶

Name In API¶

dns-profile-responses-nonexistent

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Nonexistent Responses	avg-count-per-sec	DNS rps

No Error Responses¶

Description¶

Name In API¶

dns-profile-responses-no-error

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average No Error Responses	avg-count-per-sec	DNS rps

Total Drops¶

Description¶

Name In API¶

drops-total

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Drops	count	DNS requests
Average Total Drops	avg-count-per-sec	DNS rps

Protocol Violations Improperly Formatted¶

Description¶

Name In API¶

dns-profile-sec-malformed

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Improperly Formatted Protocol Violations	avg-count-per-sec	violations/s

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

Rapid Fast NX Domain¶

Description¶

Name In API¶

dns-profile-fast-nx-domain

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Rapid Responses With Last Action: Fast NX Domain	avg-count-per-sec	DNS rps

Hints¶

Description¶

Name In API¶

hints

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Hints	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

Requests¶

Description¶

Name In API¶

dns-profile-requests

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Requests	count	DNS requests
Average Requests	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

Server Failure Responses¶

Description¶

Name In API¶

dns-profile-responses-server-failure

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Server Failure Responses	avg-count-per-sec	DNS rps

Requests By Query Type PTR¶

Description¶

Name In API¶

requests-by-q-ptr

Metrics in the metricSet¶

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

Truncated Responses¶

Description¶

Name In API¶

dns-profile-responses-truncated

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Truncated Responses	avg-count-per-sec	DNS rps

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

No Errors¶

Description¶

Name In API¶

no-errors-total

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average No Errors	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

Responses¶

Description¶

Name In API¶

dns-profile-responses

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Responses	count	DNS requests
Average Responses	avg-count-per-sec	DNS rps

Protocol Violations Invalid Authority¶

Description¶

Name In API¶

dns-profile-sec-malicious

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Invalid Authority Protocol Violations	avg-count-per-sec	violations/s

IPv6 to IPv4 Requests¶

Description¶

Name In API¶

dns-profile-ipv6-to-ipv4-requests

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average IPv6 to IPv4 Requests	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

Error Responses¶

Description¶

Name In API¶

dns-profile-responses-error

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Error Responses	count	DNS requests
Average Error Responses	avg-count-per-sec	DNS rps

Authenticated Data Responses¶

Description¶

Name In API¶

dns-profile-responses-authenticated-data

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Authenticated Data Responses	avg-count-per-sec	DNS rps

Rapid Queries¶

Description¶

Name In API¶

dns-profile-fast-queries

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Rapid Queries	avg-count-per-sec	DNS rps

Rapid No Error¶

Description¶

Name In API¶

dns-profile-fast-no-error

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Rapid Responses With Last Action: No Error	avg-count-per-sec	DNS rps

Query Refused Responses¶

Description¶

Name In API¶

dns-profile-responses-query-refused

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Query Refused Responses	avg-count-per-sec	DNS rps

HW Cache Hit Ratio¶

Description¶

Name In API¶

dns-profile-hw-cache-hit-ratio

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
HW Cache Hit Ratio	avg-value-per-event	%

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

IPv6 to IPv4 Failures¶

Description¶

Name In API¶

dns-profile-ipv6-to-ipv4-failures

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average IPv6 to IPv4 Failures	avg-count-per-sec	DNS rps

HW Inspected¶

Description¶

Name In API¶

dns-profile-hw-inspected

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Inspected Hardware Handled Packets	avg-count-per-sec	packets/s

To DNS¶

Description¶

Name In API¶

todns

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average To Dns	avg-count-per-sec	DNS rps

Rapid Truncated¶

Description¶

Name In API¶

dns-profile-fast-truncated

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Rapid Responses With Last Action: Truncated	avg-count-per-sec	DNS rps

Unhandled¶

Description¶

Name In API¶

dns-profile-unhandled

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Unhandled	count	DNS requests
Average Unhandled	avg-count-per-sec	DNS rps

Rapid Allowed¶

Description¶

Name In API¶

dns-profile-fast-allowed

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Rapid Responses With Last Action: Allowed	avg-count-per-sec	DNS rps

Requests By Query Type NAPTR¶

Description¶

Name In API¶

requests-by-q-naptr

Metrics in the metricSet¶

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

Authoritative Answer Responses¶

Description¶

Name In API¶

dns-profile-responses-authoritative-answer

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average Authoritative Answer Responses	avg-count-per-sec	DNS rps

IPv6 to IPv4 Rewrites¶

Description¶

Name In API¶

dns-profile-ipv6-to-ipv4-rewrites

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Average IPv6 to IPv4 Rewrites	avg-count-per-sec	DNS rps

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 profile-name and get the avg-count-per-sec of dns-profile-hw-malformed

{
    "kind": "ap:query:stats:byTime",
    "module": "bigip-dns-profile",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "dns-profile-hw-malformed$avg-count-per-sec": {
                    "metricSet": "dns-profile-hw-malformed",
                    "metric": "avg-count-per-sec"
            }
    },
    "dimensionFilter": {
            "type": "eq",
            "dimension": "profile-name",
            "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 profile-name, sorted by avg-count-per-sec of dns-profile-hw-malformed

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

{
    "kind": "ap:query:stats:entitiesCount",
    "module": "bigip-dns-profile",
    "dimension": "profile-name",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    }
}

Previous Next