Back to Telegraf

DNS Query Input Plugin

plugins/inputs/dns_query/README.md

1.38.32.8 KB
Original Source

DNS Query Input Plugin

This plugin gathers information about DNS queries such as response time and result codes.

⭐ Telegraf v1.4.0 šŸ·ļø system, network šŸ’» all

Global configuration options <!-- @/docs/includes/plugin_config.md -->

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See CONFIGURATION.md for more details.

Configuration

toml
# Query given DNS server and gives statistics
[[inputs.dns_query]]
  ## servers to query
  servers = ["8.8.8.8"]

  ## Network is the network protocol name.
  # network = "udp"

  ## Domains or subdomains to query.
  # domains = ["."]

  ## Query record type.
  ## Possible values: A, AAAA, CNAME, MX, NS, PTR, TXT, SOA, SPF, SRV.
  # record_type = "A"

  ## Dns server port.
  # port = 53

  ## Query timeout
  # timeout = "2s"

  ## Include the specified additional properties in the resulting metric.
  ## The following values are supported:
  ##    "first_ip" -- return IP of the first A and AAAA answer
  ##    "all_ips"  -- return IPs of all A and AAAA answers
  # include_fields = []

Metrics

  • dns_query
    • tags:
      • server
      • domain
      • record_type
      • result
      • rcode
    • fields:
      • query_time_ms (float)
      • result_code (int, success = 0, timeout = 1, error = 2)
      • rcode_value (int)

Rcode Descriptions

rcode_valuercodeDescription
0NoErrorNo Error
1FormErrFormat Error
2ServFailServer Failure
3NXDomainNon-Existent Domain
4NotImpNot Implemented
5RefusedQuery Refused
6YXDomainName Exists when it should not
7YXRRSetRR Set Exists when it should not
8NXRRSetRR Set that should exist does not
9NotAuthServer Not Authoritative for zone
10NotZoneName not contained in zone
16BADSIGTSIG Signature Failure
16BADVERSBad OPT Version
17BADKEYKey not recognized
18BADTIMESignature out of time window
19BADMODEBad TKEY Mode
20BADNAMEDuplicate key name
21BADALGAlgorithm not supported
22BADTRUNCBad Truncation
23BADCOOKIEBad/missing Server Cookie

Example Output

text
dns_query,domain=google.com,rcode=NOERROR,record_type=A,result=success,server=127.0.0.1 rcode_value=0i,result_code=0i,query_time_ms=0.13746 1550020750001000000