Configuring DNS Statistics - BlueCat Integrity - 9.5.0

Address Manager Administration Guide

Locale
English
Product name
BlueCat Integrity
Version
9.5.0

The following section outlines the steps to configure DNS Statistics.

Attention: If you are configuring DNS Statistics to send event messages to a Splunk host, the Splunk server might truncate the DNS Statistic JSON event messages due to default size settings on the Splunk server. If this occurs, BlueCat recommends updating the truncation level set in the props.conf file. For more information, refer to the Splunk documentation.

To configure DNS Statistics on a DNS/DHCP Server:

  1. From the configuration drop-down menu, select a configuration.
  2. Select the Servers tab.
  3. Under Servers, click the name of a BDDS. The Details tab for the server opens.
  4. Click the server name menu and select Service Configuration.
  5. From the Service Type drop-down menu, select DNS Statistics under the Health Telemetry section. Address Manager queries the server and returns the current values for the service settings.
  6. Under General Settings, set the following parameters:
    • Enable DNS Statistics—select this check box to enable DNS Statistics service; deselect this check box to disable DNS Statistics service.
      Note: When you enabled DNS Statistics, the firewall rules on the DNS/DHCP Server are modified to allow egress to the specified URI endpoint. Outbound traffic is allowed for the specified IP address.
    • Polling Interval—set the frequency at which the DNS statistics events are polled. The minimum value is 1 minute and the maximum value is 30 days.
    • Output Type—select where the DNS Statistics data will be logged. You can log data to an HTTP endpoint, Splunk server, Kafka cluster, or Elasticsearch server.
      If you select HTTP, the following fields appear:
      • Output URI—enter the URI of the HTTP endpoint that will be consuming the DNS statistics information.
        Note:
        • BlueCat recommends entering the IP address of the endpoint in this field. If you are entering a hostname, you must use a different DNS server as the resolver for that host. The DNS/DHCP server you are configuring DNS statistics on can still be used as a resolver for clients, but cannot be used as a resolver for its own OS related lookups.
        • If the domain name is used in the URI, you must ensure that the domain name can be resolved on the DNS/DHCP Server.
        • The URI for the Output URI field must follow the format outlined in RFC2396.
      • Bearer Token (Optional)—enter the bearer token used to authenticate with the HTTP endpoint.
      • Healthcheck—select this check box to enable health check service; deselect this check box to disable health check service. Upon initialization, the healthcheck ensure that the downstream service is accessible and can accept the DNS statistics data.
      • Healthcheck URI—enter the URI of the HTTP endpoint that will be consuming the health check information.
        Note: The URI for the Healthcheck URI field must follow the format outlined in RFC2396.
      If you select Splunk, the following fields appear:
      • Host—enter the URI of the Splunk HEC host. The standard format of the HEC URI in Splunk Enterprise is as follows:
        <protocol>://<FQDN or IP address of the host only>:<port>
        Note:
        • BlueCat recommends entering the IP address of the endpoint in this field. If you are entering a hostname, you must use a different DNS server as the resolver for that host. The DNS/DHCP server you are configuring DNS statistics on can still be used as a resolver for clients, but cannot be used as a resolver for its own OS related lookups.
        • If the domain name is used in the URI, you must ensure that the domain name can be resolved on the DNS/DHCP Server.
        • Ensure that the HEC URI format is followed exactly as described above without adding or omitting any pieces. The port is required, even if default. Do not include extra slashes or folders in the URI.
        • The URI for the Host field must follow the format outlined in RFC2396.
      • Token—enter the Splunk HEC token.
      • Healthcheck—select this check box to enable health check service; deselect this check box to disable health check service. Upon initialization, the healthcheck ensures that the downstream service is accessible and can accept the DNS statistics data.
        Note: When selecting this check box, the DNS/DHCP Server uses the default Splunk healthcheck endpoint at /services/collector/health/1.0.
      If you select Kafka, the following fields appear:
      • Topic—enter the name of the Kafka topic to write events to.
      • Bootstrap Servers—enter a comma-separated list of host and port pairs that are the addresses of the Kafka brokers in a “bootstrap” Kafka cluster that a Kafka client connects to initially to bootstrap itself. This field supports IPv4, IPv6 and FQDN values.

        Example: 10.14.22.123:9092,10.14.23.332:9092

        Note:
        • BlueCat recommends using IP addresses in this field. If you are entering a hostname, you must use a different DNS server as the resolver for that host. The DNS/DHCP server you are configuring DNS statistics on can still be used as a resolver for clients, but cannot be used as a resolver for its own OS related lookups.
        • Do not include http or https in the addresses of the Kafka brokers.
        • If a domain name is used, you must ensure that the domain name can be resolved on the DNS/DHCP Server.
      • Key Field (Optional)—enter the log field name or tags key to use for the topic key. If the field does not exist in the log or in tags, a blank value will be used. If unspecified, the key is not sent. Kafka uses a hash of the key to choose the partition or uses round-robin if the record has no key.
      • Healthcheck—select this check box to enable health check service; deselect this check box to disable health check service. Upon initialization, the healthcheck ensures that the downstream service is accessible and can accept the DNS statistics data.
        Note: The health check URI is configured based on the Kafka Broker address.
      If you select Elasticsearch, the following fields appear:
      • Endpoint—enter the Elasticsearch endpoint to send logs to. This field supports IPv4, IPv6, and FQDN values.

        Example: http://10.24.32.122:9000

        Example: https://example.com

        Example: https://user:password@example.com

        Note:
        • BlueCat recommends using the IP address of the endpoint in this field. If you are entering a hostname, you must use a different DNS server as the resolver for that host. The DNS/DHCP server you are configuring DNS statistics on can still be used as a resolver for clients, but cannot be used as a resolver for its own OS related lookups.
        • If the domain name is used, you must ensure that the domain name can be resolved on the DNS/DHCP Server.
      • Index—enter Elasticsearch index name to write events to.
      • User—enter the basic authentication user name.
      • Password—enter the basic authentication password.
      • Healthcheck—select this check box to enable health check service; deselect this check box to disable health check service. Upon initialization, the healthcheck ensures that the downstream service is accessible and can accept the DNS statistics data.
        Note: The health check URI is configured based on the Elasticsearch instance.
    • TLS Options—select this check box to configure TLS options.
      Attention: If you enter a HTTPS endpoint in the Output URI, Healthcheck URI, Host, Bootstrap Servers, or Endpoint field when configuring output, you must select this check box and enter TLS information.
      • Under CA Certificate Upload, click Browse and locate the CA certificate (trusted third party or self-signed) that will be used to authenticate the CA signature on the TLS server certificate of the remote host.
        Note: The file containing the CA certificate or certificate bundle must be in PEM format. To ensure a successful TLS handshake, the CA certificate uploaded to the client (BDDS) should be the same CA certificate (and intermediate certificates if applicable) used by the server to authenticate the CA signature of its TLS server certificate. The CA certificate can be acquired via browser export or other trusted source, and converted to PEM format.
      • Click Upload to upload the CA certificate.
      • Select the Verify Certificate check box to attempt a TLS handshake using the uploaded CA certificate with the remote host's TLS server certificate.
        Note: Verify Certificate does not verify the authenticity of the uploaded certificate. Verify Certificate in this context only checks if the CA certificate matches correctly with the TLS server certificate to create a successful handshake.
        Note: If encountering errors with Verify Certificate, the CA/chain-CA certificates may have to be installed manually on the DNS/DHCP Server. Refer to KB-17944 on the BlueCat Customer Care portal for manual installation instructions.
      • Select the Verify Hostname check box to validate the hostname part of the URI against the CN (Common Name) or SAN (Subject Alternative Name) of the server certificate during the TLS handshake.
        Note: If using self-signed certificates, users are advised to add a subject alternative name with the IP address (see RFC 5280 4.2.1.6), or disable the Verify Hostname check.
  7. Under Buffer, set the following parameters:
    • Max Events—enter the maximum number of DNS statistics events to be stored in the memory buffer. The maximum value is 36,436,000 events.
  8. Click Update.
    If you do not have DNS service deployed to the DNS/DHCP Server, after you click Update, you must perform a DNS deployment on the DNS/DHCP Server for DNS Statistics events to be generated. If DNS service is already configured on the DNS/DHCP Server, the DNS Statistics service is enabled upon clicking Update.

    Under DNS Statistics Status, you can verify whether the DNS Statistics log service is running on the DNS/DHCP Server.

    The service batches data that is sent to the configured destination. Batches are flushed from the system and sent to the configured destination when the age of the batch reaches 1 second, or when the size of the batch reaches 1049000 bytes.

    If the service receives an HTTP response status code of 429 or greater than 500 except for 501, the service attempts to retry sending the failed request 5 times. If the service still cannot send the failed request after 5 attempts, the event message is dropped and an error message is logged.

Once you have enabled DNS Statistics, the service begins collecting statistics information and forwarding the events to the selected destination. If you enabled DNS Statistics service on an xHA pair, the primary node captures DNS statistics information.
Note: If you do not see any statistics event information being forwarded to the selected destination, verify that DNS service has been configured and deployed to the DNS/DHCP Server.

In the event of a service disruption, such as a network error or the system crashes, DNS Statistics service attempts to mitigate event loss. If there are network connectivity issues, the service retries failed requests. There might be a loss of data if the DNS Statistics process stops on the DNS/DHCP Server while DNS service is running and processing DNS statistics.