% WTDNSINFO(8) - WtDNS status information
% Jonas Eckerman <jonas@truls.org>
% 2012-10-16 17:59:00 UTC (v0.006)

# NAME

wtdnsinfo - WtDNS status information

# SYNOPSIS

	wtdnsinfo [<query> | <dig> [parameters]]

# DESCRIPTION

The **wtdnsinfo** utility shows information and statistics from the currently
running WtDNSd, and can be used to call **dig** for queries to the WtDNSd
control sockets.

Since **wtdnsd** writes the information on how to query it for information to
a file that is only readable by the user that started **wtdnsd** (typically
root), **wtdnsdinfo** must be run by the same user.

# OPTIONS

dig
:	Call **dig** with server and port set for the WtDNSd control socket.
	The rest of the **wtdnsinfo** commandline is forwarded to **dig**.

<type> <name>
:	Query the daemon for resource record <type> for domain name <name>.

<name>
:	Query the daemon for any resource records for domain name <name>.

# INFORMATION

The information from **wtdnsd** includes the following:

Daemon
:	Name and version of **wtdnsd**.

Compiled
:	Compile date and time of *wtdnsd**.

Hostname
:	Name of the host **wtdnsd** in running on.

Started
:	Date and time at wich the current instance of  **wtdnsd** was started.

Uptime
:	How long the current instance of **wtdnsd** has been running.

Listen
:	The IP addresses and ports on wich **wtdnsd** is listening, excluding
	control sockets.

# STATISTICS

The statistics are shown in tables wich includes counters of connections and
messages, and average sizes for messages.
(Traffic on control sockets are not included.)

## Counters

The counters include the following rows:

Conn In
:	Incoming connection counters (each incoming UDP packet counts as one
	connection).

Msg In
:	Incomming DNS messages (these should be queries).

Msg Out
:	Outgoing DNS messages (responses to icoming messages).

Type In
:	Resource record types queried for in incoming DNS queries.

Type Out
:	Resource record types included in DNS response messages.

The counters include the following columns:

Tot
:	Total count.

UDP
:	Count of messages/connections using UDP.

TCP
:	Count of messages/connections using TCP.

IPv4
:	Count of messages/connections over IPv4.

IPv6
:	Count of messages/connections over IPv6.

OPT
:	Count of messages with an EDNS OPT pseudo record.

DO
:	Count of messages with a DNSSEC Ok flag.

Non
:	Count of not-found responses (including NXDOMAIN).

Big
:	Count of responses that were truncated because they were to big.

Bad
:	Count of messages that were seen as invalid or broken.

Err
:	Count of messages announcing errors.

## Average Sizes

The average sizes include the following rows:

Size In
:	Average size of incoming DNS messages (these should be queries),
	excluding network overhead.

Size Out
:	Average size of outgoing DNS messages (responses to incoming
	messages), excluding network overhead.

Size Max
:	Average announced maximum size.

The average sizes include the following columns:

Msg
:	Average size of DNS messages.

UDP
:	Average size of messages over UDP.

TCP
:	Average size of messages over TCP.

OPT
:	Average size for messages with an EDNS OPT pseudo record.

# CONFIGURATION

The following global options are recognized in the configuration file.

datadir = directory
:	The directory where WtDNS resource records are stored.
	Default is "/var/lib/wtdns".

# FILES

/var/lib/wtdns/:control
:	This file contains the information needed for **wtdnsinfo** to connect
	to **wtdnsd**.

/etc/wtdns/wtdns.ini
:	The global configuration file.

# NOTES

**wtdnsinfo** requires that **wtdnsd** has been started with the _-cs_ option.
