DNS Wide IP¶
Overview¶
Module Name in API¶
bigip-dns-wideip
Product Name in API¶
dns
Dimensions¶
| Dimension | Name in API | Description |
|---|---|---|
| BIG-IP Host Name | hostname | The hostname given to the BIG-IP |
| Application Service | applicationService | |
| Sync Group | dns-sync-group | |
| BIG-IP Service Cluster | dsc-name | Clusters of BIG-IPs grouped together to have the same config |
| Wide IP Name | wip-name |
MetricSets¶
Responses¶
Description¶
Name In API¶
dns-wideip-responses
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Total Responses | count | DNS requests | |
| Average Resolved | avg-count-per-sec | DNS rps |
Alternate¶
Description¶
Name In API¶
dns-wideip-alternate
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Alternate | avg-count-per-sec | DNS rps |
Fallback¶
Description¶
Name In API¶
dns-wideip-fallback
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Fallback | avg-count-per-sec | DNS rps |
CNAME Resolutions¶
Description¶
Name In API¶
dns-wideip-cname-resolutions
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average CNAME Resolutions | avg-count-per-sec | DNS rps |
Requests¶
Description¶
Name In API¶
dns-wideip-requests
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Total Requests | count | DNS requests | |
| Average Requests | avg-count-per-sec | DNS rps |
Return To DNS¶
Description¶
Name In API¶
dns-wideip-return-to-dns
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Return To DNS | avg-count-per-sec | DNS rps |
Preferred¶
Description¶
Name In API¶
dns-wideip-preferred
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Average Preferred | avg-count-per-sec | DNS rps |
Drops¶
Description¶
Name In API¶
dns-wideip-dropped
Metrics in the metricSet¶
| Metric | Name in API | Unit | Description |
|---|---|---|---|
| Total Drops | count | DNS requests | |
| Average Drops | 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 hostname and get the count of dns-wideip-responses
{
"kind": "ap:query:stats:byTime",
"module": "bigip-dns-wideip",
"timeRange": {
"from": "-1h",
"to": "now"
},
"timeGranularity": {
"duration": 30,
"unit": "SECONDS"
},
"aggregations": {
"dns-wideip-responses$count": {
"metricSet": "dns-wideip-responses",
"metric": "count"
}
},
"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 count of dns-wideip-responses
{
"kind": "ap:query:stats:byEntities",
"module": "bigip-dns-wideip",
"timeRange": {
"from": "-1H",
"to": "now"
},
"dimension": "hostname",
"sortMetric": "dns-wideip-responses$count",
"sortOrder": "desc",
"aggregations": {
"dns-wideip-responses$count": {
"metricSet": "dns-wideip-responses",
"metric": "count"
}
},
"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-wideip",
"dimension": "hostname",
"timeRange": {
"from": "-1h",
"to": "now"
}
}