dns-metrics

Objects

• DNS Metric Connection Latency Stats
• DNS Metric Event
• DNS Metric Header
• DNS Metric Stats
  • DNS Metric Connection Information
    • DNS Metric QUIC Connection Information
• DNS Metric TCP Connection Information
• DNS Metric TLS Connection Information
• DNS Metric UDP Connection Information
• DNS Metrics (root object)

---

DNS Metric Connection Information

---

DNS Metric Connection Latency Stats

DNS Metric Connection Latency Stats Properties

	Type	Description	Required
avg	integer	The average latency, in nanoseconds	No
min	integer	The minimum latency, in nanoseconds	No
max	integer	The maximum latency, in nanoseconds	No
stddev	integer	The standard deviation for latency, in nanoseconds	No
buckets	array []	??TODO??	No

Additional properties are allowed.

conn_latency_stats.avg

The average latency, in nanoseconds

• Type: integer
• Required: No

conn_latency_stats.min

The minimum latency, in nanoseconds

• Type: integer
• Required: No

conn_latency_stats.max

The maximum latency, in nanoseconds

• Type: integer
• Required: No

conn_latency_stats.stddev

The standard deviation for latency, in nanoseconds

• Type: integer
• Required: No

conn_latency_stats.buckets

??TODO??

• Type: array []
• Required: No

---

DNS Metric Event

A generic event object for tools to give context on the run

DNS Metric Event Properties

	Type	Description	Required
msg	string	The message about the event	✓ Yes
msg_type	string	The type of message	No

Additional properties are allowed.

event.msg

The message about the event

• Type: string
• Required: ✓ Yes

event.msg_type

The type of message

• Type: string
• Required: No

---

DNS Metric Header

A header object that contains information on the schema version and parameters related to the run

DNS Metric Header Properties

	Type	Description	Required
schema_version	integer	The DNS metrics schema version in the format YYYYMMDD	✓ Yes
generator	string	The name of the software that generated this output	✓ Yes
generator_version	string	The version of the software	✓ Yes
generator_params	string []	Any parameters that was given to the software	No
time_units_per_sec	integer	??TODO??	No
stats_interval	number	The frequency of stats objects in this file, in fractional seconds	✓ Yes
timeout	number	The network timeout used in the generator, in fractional seconds	No

Additional properties are allowed.

header.schema_version

The DNS metrics schema version in the format YYYYMMDD

• Type: integer
• Required: ✓ Yes

header.generator

The name of the software that generated this output

• Type: string
• Required: ✓ Yes

header.generator_version

The version of the software

• Type: string
• Required: ✓ Yes

header.generator_params

Any parameters that was given to the software

• Type: string []
• Required: No

header.time_units_per_sec

??TODO??

• Type: integer
• Required: No

header.stats_interval

The frequency of stats objects in this file, in fractional seconds

• Type: number
• Required: ✓ Yes

header.timeout

The network timeout used in the generator, in fractional seconds

• Type: number
• Required: No

---

DNS Metric QUIC Connection Information

An object with the metrics around the QUIC connections used to sent and received for the given stats object

---

DNS Metric Stats

A stats object with the metrics around the DNS that was sent and received during the run

DNS Metric Stats Properties

	Type	Description	Required
since	integer	The starting time for when the metrics of this object was gathered, in nanoseconds since 1970-01-01 00:00:00 UTC	✓ Yes
until	integer	The ending time for when the metrics of this object was gathered, in nanoseconds since 1970-01-01 00:00:00 UTC	✓ Yes
queries	integer	The number of DNS queries	No
responses	integer	The number of DNS responses	No
timeouts	integer	The number of DNS queries that timed out	No
interrupted	integer	The number of DNS queries and/or responses that was interrupted	No
unexpected	integer	The number of DNS queries and/or responses that was unexpected	No
discarded	integer	The number of DNS queries and/or responses that was discarded	No
response_rcodes	object	The number of different RCODEs as an object with the RCODE as a property	No
response_latency	object	The latency metrics for responses to queries	No
conn_info	conn_info		No

Additional properties are allowed.

stats.since

The starting time for when the metrics of this object was gathered, in nanoseconds since 1970-01-01 00:00:00 UTC

• Type: integer
• Required: ✓ Yes

stats.until

The ending time for when the metrics of this object was gathered, in nanoseconds since 1970-01-01 00:00:00 UTC

• Type: integer
• Required: ✓ Yes

stats.queries

The number of DNS queries

• Type: integer
• Required: No

stats.responses

The number of DNS responses

• Type: integer
• Required: No

stats.timeouts

The number of DNS queries that timed out

• Type: integer
• Required: No

stats.interrupted

The number of DNS queries and/or responses that was interrupted

• Type: integer
• Required: No

stats.unexpected

The number of DNS queries and/or responses that was unexpected

• Type: integer
• Required: No

stats.discarded

The number of DNS queries and/or responses that was discarded

• Type: integer
• Required: No

stats.response_rcodes

The number of different RCODEs as an object with the RCODE as a property

• Type: object
• Required: No

stats.response_latency

The latency metrics for responses to queries

• Type: object
• Required: No

stats.conn_info

• Type: conn_info
• Required: No

---

DNS Metric TCP Connection Information

An object with the metrics around the TCP connections used to sent and received for the given stats object

---

DNS Metric TLS Connection Information

An object with the metrics around the TLS connections used to sent and received for the given stats object

---

DNS Metric UDP Connection Information

An object with the metrics around the UDP connections used to sent and received for the given stats object

DNS Metric UDP Connection Information Properties

	Type	Description	Required
packets_sent	integer	The number of packets sent	No
packets_received	integer	The number of packets received	No
socket_errors	integer	The number of various socket errors that occurred	No

Additional properties are allowed.

tls_conn.packets_sent

The number of packets sent

• Type: integer
• Required: No

tls_conn.packets_received

The number of packets received

• Type: integer
• Required: No

tls_conn.socket_errors

The number of various socket errors that occurred

• Type: integer
• Required: No

---

DNS Metrics

A DNS metrics object

DNS Metrics Properties

	Type	Description	Required
runid	string	The unique id for a run, used to correlate all objects to the same run	✓ Yes
subid	string	The unique id within a run, used to differentiate for example individual threads or streams within the run	No

Additional properties are allowed.

DNS Metrics.runid

The unique id for a run, used to correlate all objects to the same run

• Type: string
• Required: ✓ Yes

DNS Metrics.subid

The unique id within a run, used to differentiate for example individual threads or streams within the run

• Type: string
• Required: No

This site is open source. Improve this page.