/v2/diagnostics - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide

Locale
English
Product name
BlueCat Edge
Version
Service Point v4.x.x

Retrieve diagnostics information about the DNS resolver service deployed to the Service Point v4 instance.

Request: GET http://<spv4_ip_address>:2021/v2/diagnostics

Successful response

200 OK
{
  "status": "GOOD",
  "id": "12345678-0b31-4d52-a1b5-099a9cbe9773",
  "clusterId": "test_fsp_1-a8ka819ut-use2oudmd5pq",
  "applicationId": "12345678-db02-4c9a-a7ab-593bb8bd604c",
  "currentVersion": "3.5.4",
  "statusTimestamp": 1661950287144,
  "services": [
    {
      "id": "sp-controller-service",
      "status": "GOOD",
      "statusTimestamp": 1661950287009,
      "serviceVersion": "1.0.0-build1013",
      "resourceDetails": {
        "customer-instance-connection": "GOOD"
      },
      "additionalDetails": {
        "dns-resolving-responses": {
          "rootNSQuery": "NOERROR",
          "edgeCloudEndpoint": "NOERROR"
        }
      },
      "resources": [
        {
          "id": "customerInstanceConnection",
          "type": "customerInstanceConnection",
          "status": "GOOD",
          "info": [],
          "errors": []
        },
        {
          "id": "dnsResolvingResponses",
          "type": "dnsResolvingResponses",
          "status": "GOOD",
          "info": [
            {
              "name": "rootNSQuery",
              "value": "NOERROR"
            },
            {
              "name": "edgeCloudEndpoint",
              "value": "NOERROR"
            }
          ],
          "errors": []
        },
        {
          "id": "certificates",
          "type": "certificates",
          "status": "GOOD",
          "info": [
            {
              "name": "clientCertificateExpiration",
              "value": 1725729422000
            },
            {
              "name": "caCertificateExpiration",
              "value": 1725729422000
            }
          ],
          "errors": []
        }
      ]
    },
    {
      "id": "parclo-logging",
      "status": "GOOD",
      "statusTimestamp": 1661950287124,
      "serviceVersion": "1.0.0-build1656",
      "resourceDetails": {
        "kinesis-stream-status": "GOOD"
      },
      "additionalDetails": {
        "custom-logging-endpoint": {
          "url": "",
          "header-names": [],
          "sha256-fingerprint": ""
        },
        "stored-offline-queries-bytes": 0,
        "kinesis-put_success": 0,
        "logging-endpoint-dropped-count": 0,
        "logging-endpoint-put-success-count": 0,
        "incoming-dns-events-dropped-count": 0,
        "logging-to-edge-cloud-console": true,
        "kinesis-put_fail": 0,
        "logging-to-custom-logging-endpoint": false,
        "logging-endpoint-put-failed-count": 0
      },
      "resources": [
        {
          "id": "unlogged-queries",
          "type": "unlogged-queries",
          "status": "N/A",
          "info": [
            {
              "name": "stored-offline-queries-bytes",
              "value": 0
            },
            {
              "name": "incoming-dns-events-dropped-count",
              "value": 0
            }
          ],
          "errors": []
        },
        {
          "id": "logging-endpoint",
          "type": "logging-endpoint",
          "status": "N/A",
          "info": [
            {
              "name": "logging-endpoint-dropped-count",
              "value": 0
            },
            {
              "name": "logging-endpoint-put-success-count",
              "value": 0
            },
            {
              "name": "logging-endpoint-put-failed-count",
              "value": 0
            }
          ],
          "errors": []
        },
        {
          "id": "kinesis-stream",
          "type": "kinesis-stream",
          "status": "GOOD",
          "info": [
            {
              "name": "kinesis-put_success",
              "value": 0
            },
            {
              "name": "kinesis-put_fail",
              "value": 0
            }
          ],
          "errors": []
        },
        {
          "id": "firehose-credentials",
          "type": "firehose-credentials",
          "status": "GOOD",
          "info": [
            {
              "name": "firehose-credential-expiration",
              "value": 1661951004000
            }
          ],
          "errors": []
        }
      ]
    },
    {
      "id": "dns-gateway-service",
      "status": "GOOD",
      "statusTimestamp": 1661950287134,
      "serviceVersion": "2.0.0-build3243",
      "additionalDetails": {
        "settingsDiagnostics": {
          "id": "ebe07778380e1cd1b77c5fb3d2c25f37f9ab3ed1",
          "lastSettingsPollingTimestamp": 1661950287130,
          "lastSuccessfulSettingsUpdateTimestamp": 1661950287130,
          "lastSettingsPollingStatus": "UNCHANGED",
          "namespaceDetails": [
            {
              "id": "f73b86e9-ad83-4a68-89fe-4864eb1b7b33",
              "name": "test-Azure-NS",
              "forwarders": [
                "10.10.10.9"
              ],
              "matchListsDomainCount": 58,
              "exceptionListsDomainCount": 0,
              "matchesAllDomains": true,
              "matchCidrCount": 0,
              "exceptionCidrCount": 0,
              "ttl": -1,
              "staleCacheEntriesTTL": 3600,
              "umbrellaConfiguration": null,
              "ecsConfiguration": null,
              "dohEnabled": false,
              "retryRCodes": [
                3
              ]
            },
            {
              "id": "c64ad2f0-ea0c-466c-ac60-e37794fdb515",
              "name": "MS-AZURE-INTERNAL",
              "forwarders": [
                "168.63.129.16"
              ],
              "matchListsDomainCount": 4,
              "exceptionListsDomainCount": 0,
              "matchesAllDomains": false,
              "matchCidrCount": 0,
              "exceptionCidrCount": 0,
              "ttl": 10,
              "staleCacheEntriesTTL": 3600,
              "umbrellaConfiguration": null,
              "ecsConfiguration": null,
              "dohEnabled": false,
              "retryRCodes": [
                3
              ]
            },
            {
              "id": "ad73c5cf-27a8-11e8-9308-0ae4387b2600",
              "name": "Default",
              "forwarders": [
                "8.8.8.8",
                "8.8.4.4"
              ],
              "matchListsDomainCount": 1,
              "exceptionListsDomainCount": 0,
              "matchesAllDomains": true,
              "matchCidrCount": 3,
              "exceptionCidrCount": 0,
              "ttl": -1,
              "staleCacheEntriesTTL": 3600,
              "umbrellaConfiguration": null,
              "ecsConfiguration": null,
              "dohEnabled": false,
              "retryRCodes": [
                3
              ]
            }
          ]
        },
        "policyDiagnostics": {
          "id": "-2000278519",
          "policyEventTimestamp": 1661950287130,
          "lastUpdateTimestamp": 1661950287130,
          "lastPolicyEventResult": "UNCHANGED",
          "policyDetails": [
            {
              "policyName": "test-Monitor-All",
              "policyId": "1654021252273-c0161143-ea7c-49e3-8f97-24384f6ad914",
              "numberDomains": 0,
              "numberExceptions": 0,
              "policyAction": "monitor"
            },
            {
              "policyName": "Block Internet Facing Queries",
              "policyId": "1654525863398-a8f3a676-b1f9-4fb4-b49a-5b64dd6af5f7",
              "numberDomains": 0,
              "numberExceptions": 0,
              "policyAction": "block"
            },
            {
              "policyName": "test-Azure-Feeds",
              "policyId": "1654524700188-de8bf889-b7d6-413a-af74-f9d008055bfe",
              "numberDomains": 2712844,
              "numberExceptions": 0,
              "policyAction": "block"
            }
          ]
        },
        "timeZone": "America/Toronto"
      },
      "resources": [
        {
          "id": "namespace-f73b86e9-ad83-4a68-89fe-4864eb1b7b33",
          "type": "namespace",
          "status": "GOOD",
          "info": [
            {
              "name": "responses",
              "value": 0
            },
            {
              "name": "servfail-responses",
              "value": 0
            },
            {
              "name": "queries",
              "value": 0
            },
            {
              "name": "frontend-nxdomain",
              "value": 0
            },
            {
              "name": "frontend-servfail",
              "value": 0
            },
            {
              "name": "frontend-noerror",
              "value": 0
            },
            {
              "name": "acl-drops",
              "value": 0
            },
            {
              "name": "rule-drop",
              "value": 0
            },
            {
              "name": "rule-nxdomain",
              "value": 0
            },
            {
              "name": "rule-refused",
              "value": 0
            },
            {
              "name": "rule-servfail",
              "value": 0
            },
            {
              "name": "rule-truncated",
              "value": 0
            },
            {
              "name": "self-answered",
              "value": 0
            },
            {
              "name": "downstream-timeouts",
              "value": 0
            },
            {
              "name": "downstream-send-errors",
              "value": 0
            },
            {
              "name": "trunc-failures",
              "value": 0
            },
            {
              "name": "no-policy",
              "value": 0
            },
            {
              "name": "latency0-1",
              "value": 0
            },
            {
              "name": "latency1-10",
              "value": 0
            },
            {
              "name": "latency10-50",
              "value": 0
            },
            {
              "name": "latency50-100",
              "value": 0
            },
            {
              "name": "latency100-1000",
              "value": 0
            },
            {
              "name": "latency-slow",
              "value": 0
            },
            {
              "name": "latency-avg100",
              "value": 0
            },
            {
              "name": "latency-avg1000",
              "value": 0
            },
            {
              "name": "latency-avg10000",
              "value": 0
            },
            {
              "name": "latency-avg1000000",
              "value": 0
            },
            {
              "name": "uptime",
              "value": 499128
            },
            {
              "name": "real-memory-usage",
              "value": 80310272
            },
            {
              "name": "udp-in-errors",
              "value": 0
            },
            {
              "name": "udp-noport-errors",
              "value": 22
            },
            {
              "name": "udp-recvbuf-errors",
              "value": 0
            },
            {
              "name": "udp-sndbuf-errors",
              "value": 0
            },
            {
              "name": "tcp-listen-overflows",
              "value": 0
            },
            {
              "name": "noncompliant-queries",
              "value": 0
            },
            {
              "name": "noncompliant-responses",
              "value": 0
            },
            {
              "name": "proxy-protocol-invalid",
              "value": 0
            },
            {
              "name": "rdqueries",
              "value": 0
            },
            {
              "name": "empty-queries",
              "value": 0
            },
            {
              "name": "cache-hits",
              "value": 0
            },
            {
              "name": "cache-misses",
              "value": 0
            },
            {
              "name": "cpu-iowait",
              "value": 791111
            },
            {
              "name": "cpu-steal",
              "value": 0
            },
            {
              "name": "cpu-sys-msec",
              "value": 204291
            },
            {
              "name": "cpu-user-msec",
              "value": 882943
            },
            {
              "name": "fd-usage",
              "value": 46
            },
            {
              "name": "dyn-blocked",
              "value": 0
            },
            {
              "name": "dyn-block-nmg-size",
              "value": 0
            },
            {
              "name": "security-status",
              "value": 0
            },
            {
              "name": "doh-query-pipe-full",
              "value": 0
            },
            {
              "name": "doh-response-pipe-full",
              "value": 0
            },
            {
              "name": "latency-sum",
              "value": 0
            },
            {
              "name": "latency-count",
              "value": 0
            }
          ],
          "errors": []
        },
        {
          "id": "memory",
          "type": "container",
          "status": "N/A",
          "info": [
            {
              "name": "allocated-mb",
              "value": 160
            }
          ]
        }
      ]
    },
    {
      "id": "status-service",
      "status": "GOOD",
      "statusTimestamp": 1661950287144,
      "serviceVersion": "2.0.0-build582",
      "resources": [
      {
          "id": "memory",
          "type": "container",
          "status": "N/A",
          "info": [
            {
              "name": "allocated-mb",
              "value": 160
            }
          ]
        }
      ]
    }
  ],
  "additionalDetails": {
    "hostManager": "SDP",
    "currentLocalTime": "2022-08-31 12:51:27",
    "proxyConfiguration": {
      "configured": false,
      "protocol": null,
      "port": null,
      "host": null,
      "authenticationEnabled": null
    }
  },
  "registration": {
    "registered": true,
    "timestamp": 1656012490546,
    "siteId": "12345678-9870-98ef-85dc-34faaca80643",
    "customerId": "12345678-abcd-12ab-7890-acb9a5a1eg2",
    "customerHostname": "customer.edge.bluec.at"
  }
}

Namespace details

Under settingsDiagnostics, nameSpaceDetails, the parameter matchListDomainCount returns the total count of domains in the match lists attached to the namespace. However, "." represents all domains, but is counted as a single domain in the context of the domain list count. As a result, the parameter matchesAllDomains returns true or false in the following situations:
  • When one domain list is provided and contains "." as a domain, then matchesAllDomains will be true, but matchListDomainCount is 1.
  • If more than 1 domain list is provided, but any list contains "." as a domain, then the flag will be true and the "matchListDomainCount" reflects the count of domains across all domain lists (counting "." as one domain).
  • If no domain list is provided, then matchesAllDomains is true, but matchListDomainCount is 0.
  • If a domain list is provided with domains other than "." then matchesAllDomains is false, and matchListDomainCount reflects the count of domains in that list.

The exceptionsListDomainCount parameter is the total count of domains in the exception domain lists attached to the namespace.

Update information

In the updates section, the task field will display UPGRADING regardless of whether the service point is upgrading to a newer DNS resolver service software version or downgrading to an older software version.

Registration information

The field registrationFailureReason is only returned when the registration status is FAILED. If the registration state can't be determined, the status returned is N/A.