EOP-275: Updating summary pages with new DNS info (#780)

SparkPost · Nov 5, 2024 · 946245d · 946245d
1 parent 4f5a1e7
commit 946245d
Show file tree

Hide file tree

Showing 2 changed files with 169 additions and 10 deletions.
diff --git a/content/momentum/4/console-commands/summary.md b/content/momentum/4/console-commands/summary.md
@@ -1,5 +1,5 @@
 ---
-lastUpdated: "05/08/2023"
+lastUpdated: "11/05/2024"
 title: "summary"
 description: "summary show global metrics summary with mobile Perhaps the most common and useful command for the console summary will produce global metrics such as queue sizes message counts and throughput rates since startup or the last reset of statistics If you have configured your control listener to listen on the..."
 ---
@@ -26,12 +26,20 @@ Summary Statistics
         Active Domains:   35711
         Active Queue Size:   8793
         Delayed Queue Size: 263175
-        Destaged Queue Size:      0
         Total Queue Size: 272334
+        DNS Resolver: ares
         DNS A Queries: 565284
+        DNS A Timeouts: 11
+        DNS AAAA Queries: 0
+        DNS AAAA Timeouts: 0
         DNS MX Queries: 243281
+        DNS MX Timeouts: 6
+        DNS TXT Queries: 39841
+        DNS TXT Timeouts: 0
         Pending DNS Queries: 116
         Query Rate:   9.08 queries/second
+        DNS Response Time Peak:  469 ms
+        DNS Response Time Average:  0.302 ms
         Successfully Delivered Messages: 2102439
         Failed Messages: 2508439
         Rejected Messages:      1
@@ -88,35 +96,91 @@ The number of messages in the system that have been delayed. A message is delaye
 
 </dd>
 
-<dt>Destaged Queue Size</dt>
+<dt>Total Queue Size</dt>
 
 <dd>
 
-The number of messages that have been destaged from the system.
+The sum of all queues.
 
 </dd>
 
-<dt>Total Queue Size</dt>
+<dt>DNS Resolver</dt>
 
 <dd>
 
-The sum of all queues.
+The library used to resolve DNS queries.
 
 </dd>
 
 <dt>DNS A Queries</dt>
 
 <dd>
 
-The total number of A/AAAA type queries issued since startup or last summary reset.
+The total number of A type queries issued since startup or last summary reset.
+
+</dd>
+
+<dt>DNS A Timeouts</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of A type queries that resulted expired since startup or last summary reset.
+
+</dd>
+
+<dt>DNS AAAA Queries</dt>
+
+<dd>
+
+The total number of AAAA type queries issued since startup or last summary reset.
+
+</dd>
+
+<dt>DNS AAAA Timeouts</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of AAAA type queries that resulted expired since startup or last summary reset.
 
 </dd>
 
 <dt>DNS MX Queries</dt>
 
 <dd>
 
-The total number of MX type DNS queries issued since startup or last summary reset.
+The total number of MX type queries issued since startup or last summary reset.
+
+</dd>
+
+<dt>DNS MX Timeouts</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of MX type queries that resulted expired since startup or last summary reset.
+
+<dt>DNS TXT Queries</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of TXT type queries issued since startup or last summary reset.
+
+</dd>
+
+<dt>DNS TXT Timeouts</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of TXT type queries that resulted expired since startup or last summary reset.
 
 </dd>
 
@@ -136,6 +200,26 @@ The average number of DNS queries/second performed since startup or last summary
 
 </dd>
 
+<dt>DNS Response Time Peak</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The peak of all answers response times since startup or last summary reset, in milliseconds.
+
+</dd>
+
+<dt>DNS Response Time Average</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The average of all answers response times since startup or last summary reset, in milliseconds.
+
+</dd>
+
 <dt>Successfully Delivered Messages</dt>
 
 <dd>

diff --git a/content/momentum/4/http-api-stats/summary.md b/content/momentum/4/http-api-stats/summary.md
@@ -1,5 +1,5 @@
 ---
-lastUpdated: "05/08/2023"
+lastUpdated: "11/05/2024"
 title: "Summary"
 description: "stats summary show global metrics Perhaps the most common API command stats summary will produce global metrics such as queue sizes message counts and throughput rates since startup or the last reset of statistics"
 ---
@@ -31,9 +31,16 @@ Sample output is shown below:
   "TotalQueueSize": 47,
   "DNSResolver": "ares",
   "DNSAQueries": 6307067,
+  "DNSATimeouts": 34,
   "DNSAAAAQueries": 0,
+  "DNSAAAATimeouts": 0,
   "DNSMXQueries": 5361180,
+  "DNSMXTimeouts": 22,
+  "DNSTXTQueries": 114992,
+  "DNSTXTTimeouts": 57,
   "DNSQueryRate": 2.25,
+  "DNSResponseTimePeak": 291,
+  "DNSResponseTimeAverage": 1.04,
   "ResidentMessages": 120,
   "DiskQueueProgress": "    29/    29",
   "DeliveredMessages": 516030153,
@@ -118,6 +125,16 @@ The total number of A type queries issued since startup or last summary reset.
 
 </dd>
 
+<dt>DNSATimeouts</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of A type queries that resulted expired since startup or last summary reset.
+
+</dd>
+
 <dt>DNSAAAAQueries</dt>
 
 <dd>
@@ -126,6 +143,16 @@ The total number of AAAA type queries issued since startup or last summary reset
 
 </dd>
 
+<dt>DNSAAAATimeouts</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of AAAA type queries that resulted expired since startup or last summary reset.
+
+</dd>
+
 <dt>DNSMXQueries</dt>
 
 <dd>
@@ -134,6 +161,34 @@ The total number of MX type DNS queries issued since startup or last summary res
 
 </dd>
 
+<dt>DNSMXTimeouts</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of MX type queries that resulted expired since startup or last summary reset.
+
+<dt>DNSTXTQueries</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of TXT type queries issued since startup or last summary reset.
+
+</dd>
+
+<dt>DNSTXTTimeouts</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The total number of TXT type queries that resulted expired since startup or last summary reset.
+
+</dd>
+
 <dt>DNSQueryRate</dt>
 
 <dd>
@@ -142,6 +197,26 @@ The average number of DNS queries/second performed since startup or last summary
 
 </dd>
 
+<dt>DNSResponseTimePeak</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The peak of all answers response times since startup or last summary reset, in milliseconds.
+
+</dd>
+
+<dt>DNSResponseTimeAverage</dt>
+
+<dd>
+
+_Introduced in Momentum 4.8._
+
+The average of all answers response times since startup or last summary reset, in milliseconds.
+
+</dd>
+
 <dt>ResidentMessages</dt>
 
 <dd>
@@ -254,4 +329,4 @@ The number of seconds that Momentum has been running continuously.
 
 ## Note
 
-This command was implemented in Momentum 4.4.1.
+This command was first implemented in Momentum 4.4.1.