Log Argument Key Glossary
This glossary defines canonical log argument keys for machine consumers.
It complements docs/specifications/log-args-coherency.md.
Contract version:
v1.1 (documentation version, not emitted in runtime args)
Scope:
- Normative for all tags following the coherency contract.
- Migration is complete; all engine emitters use canonical keys.
Value Escaping
A string value, also inside a list or map, carries no control octet. The
logger writes each octet of a C0 control (0x00 to 0x1F), of DEL (0x7F), of
a C1 control (U+0080 to U+009F) and of invalid UTF-8 as \DDD, its decimal
value (RFC 1035 section 5.1). Spaces and other UTF-8 pass unchanged, since a
value MAY be free text. RFC 4343 section 2.1 also escapes those octets in a
name; the query trace applies that full set to nameserver and query names.
Core Identity Keys
| Key | Type | Meaning | Notes |
|---|
ns | string | Nameserver name (FQDN string). | Name only. Never name/ip. |
address | string | Single nameserver IP address. | Use together with ns when both are known. |
domain | string | Domain name in testcase-specific contexts. | Keep testcase meaning explicit. |
mname | string | SOA MNAME hostname. | Hostname only. |
signer | string | Signer’s Name of an RRSIG record. | Zone apex name. Never the owner name of the signed RRset. |
zone | string | Zone apex name a finding is about. | Never the zone under test. Use signer where the name comes from an RRSIG. |
asn | int | Autonomous system number. | Integer in 1 to 4294967295. Used where a finding names exactly one AS; asns carries a list. |
Query Identity Keys
| Key | Type | Meaning | Notes |
|---|
query_name | string | DNS owner name queried. | |
query_type | string | DNS RR type queried. | Uppercase form (for example SOA). |
query_class | string | DNS class queried. | Usually IN. |
Message Size Keys
| Key | Type | Meaning | Notes |
|---|
size | int | DNS message size in bytes. | Wire length of the message observed. |
payload | int | Advertised EDNS(0) requestor UDP payload size in bytes. | The value carried on the query the observation describes. |
Structured Collection Keys
| Key | Type | Meaning | Notes |
|---|
servers | array<object> | Endpoint list for machine use. | Items use { "ns": "...", "address": "..." }. |
addresses | array<string> | IP address list. | |
asns | array<int> | ASN list. | Integer ASN values. |
prefixes | array<string> | CIDR prefix list. | |
ptr_names | array<string> | PTR hostname list from reverse-DNS checks. | Used for PTR mismatch detail payloads. |
mail_targets | array<string> | MX target hostname list. | Replaces mailtarget_list. |
mx_rdata | array<string> | MX RDATA list, each element a preference and exchange separated by a space. | mail_targets carries the exchange names of the same RRset. |
DNSSEC Algorithm Keys
| Key | Type | Meaning | Notes |
|---|
ds_key_algo_num | int | Algorithm field value from DS RDATA (the DNSKEY algorithm the DS references). | Distinct from ds_algo_num (DS digest type) and algo_num (DNSKEY record algorithm). |
ds_key_algo_descr | string | Text description of the DS algorithm field value. | |
ds_key_algo_mnemo | string | DNSSEC algorithm mnemonic for the DS algorithm field value (for example PRIVATEDNS). | |
DNSSEC Signature Keys
| Key | Type | Meaning | Notes |
|---|
reason | string | Why an RRSIG does not verify, on the tags of a signature that does not verify. | labels: the Labels field exceeds the owner’s label count (RFC 4035 section 5.3.1), or the owner rebuilt from it (RFC 4035 section 5.3.2) is not at or below the Signer’s Name, or is the Signer’s Name and differs from the owner. signature: any other failure. On a tag outside DNSSEC, such as IPV6_AUTO_DISABLED, free text. |
Denial Of Existence Keys
| Key | Type | Meaning | Notes |
|---|
owner | string | Owner name of the NSEC or NSEC3 record whose interval covers another record, lowercased. | The full name as served, hashed label included for NSEC3. |
covered | string | Owner name of the NSEC or NSEC3 record that lies inside the interval of owner, lowercased. | |
next | string | Next field of the record at owner. | Next Hashed Owner Name in base32hex for NSEC3, Next Domain Name for NSEC. |
Limit Keys
| Key | Type | Meaning | Notes |
|---|
bound | string | Name of an implementation-defined bound. | Values in nameserver-resolution.md
. |
limit | int | Value of the bound or configured limit. | |
count | int | Number of items counted. | Beside limit, the count the limit applies to. |
Temporal Keys
| Key | Type | Meaning | Notes |
|---|
date | string | Human-visible timestamp argument in tag-specific contexts. | Use UTC RFC3339 (ISO 8601 profile). |
Role-Specific Collection Variants
Use role-specific server collections where needed, with the same endpoint item
shape as servers:
parent_serverschild_serversfailing_servers
Retired Legacy Keys
These keys are no longer emitted by the engine. If encountered in historical
outputs or external adapters, they are non-canonical:
ip (replaced by address)name, server (replaced by ns or context-specific keys)nsname, ns_ip (replaced by ns + address)ns_list, ns_ip_list, nsname_list (replaced by servers)asn_list (replaced by asns)- query aliases
type, class, rrtype (replaced by query_name, query_type, query_class) - delimiter-packed identity fields (
; or ,) without typed counterparts
CI guardrails reject reintroduction of these patterns.