Skip to main content

Name

/stats/summary — global metrics

Synopsis

GET /stats/summary

DELETE /stats/summary

Description

Gather Global Metrics

Perhaps the most common API command, GET /stats/summary will produce global metrics such as queue sizes, message counts and throughput rates since startup or the last reset of statistics.

The data is formatted as a JSON object and you might want to use the curl command to do the request (e.g. curl -sS localhost:2081/stats/summary).

Sample output is shown below:

{
  "OutboundConcurrency": 209,
  "InboundConcurrency": 1340,
  "ActiveDomains": 8253,
  "ActiveQueueSize": 39,
  "DelayedQueueSize": 2,
  "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,
  "DNSRateLimiterEnabled": false,
  "ResidentMessages": 120,
  "DiskQueueProgress": "    29/    29",
  "DeliveredMessages": 516030153,
  "FailedMessages": 6406412,
  "TransientFailures": 7533966,
  "RejectedMessages": 0,
  "ReceivedMessages": 522356470,
  "DeliveryRate": 100.85,
  "ReceptionRate": 100.84,
  "RejectionRate": 0,
  "RejectionPercentage": 0,
  "StatisticsLastReset": 5180099,
  "Uptime": 510923
}

The report fields are as follows:

OutboundConcurrency

The current number of established outbound sessions.

InboundConcurrency

The current number of established inbound sessions.

ActiveDomains

The number of domains in the DNS cache.

ActiveQueueSize

The number of messages in the system that require immediate delivery attempts.

DelayedQueueSize

The number of messages in the system that have been delayed. A message is delayed due to transient delivery failures (4xx SMTP codes) and a retry time is calculated for the message. When that retry time is reached, the message will be moved from the delayed queue to the active queue.

TotalQueueSize

The sum of all queues.

DNSResolver

The library used to resolve DNS queries.

DNSAQueries

The total number of A type queries issued since startup or last summary reset.

DNSATimeouts

Introduced in Momentum 4.8.

The total number of A type queries that resulted expired since startup or last summary reset.

DNSAAAAQueries

The total number of AAAA type queries issued since startup or last summary reset.

DNSAAAATimeouts

Introduced in Momentum 4.8.

The total number of AAAA type queries that resulted expired since startup or last summary reset.

DNSMXQueries

The total number of MX type DNS queries issued since startup or last summary reset.

DNSMXTimeouts

Introduced in Momentum 4.8.

The total number of MX type queries that resulted expired since startup or last summary reset.

DNSTXTQueries

Introduced in Momentum 4.8.

The total number of TXT type queries issued since startup or last summary reset.

DNSTXTTimeouts

Introduced in Momentum 4.8.

The total number of TXT type queries that resulted expired since startup or last summary reset.

DNSQueryRate

The average number of DNS queries/second performed since startup or last summary reset.

DNSResponseTimePeak

Introduced in Momentum 4.8.

The peak of all answers response times since startup or last summary reset, in milliseconds.

DNSResponseTimeAverage

Introduced in Momentum 4.8.

The average of all answers response times since startup or last summary reset, in milliseconds.

DNSRateLimiterEnabled

Introduced in Momentum 5.3.

Whether the DNS rate limiter is enabled (true) or disabled (false). When the rate limiter is enabled, the following additional fields are also reported:

DNSRateLimitMXQueries

The current value of dns_rate_limit_mx_queries — the maximum number of MX DNS queries dispatched per DNSRateLimitPeriod.

DNSRateLimitPeriod

The current value of dns_rate_limit_period — the period, in seconds, over which the MX query budget is enforced.

DNSRateLimiterQueueSize

The current number of domains waiting in the rate limiter queue for a token.

DNSRateLimiterQueueMax

The maximum number of domains that may be held in the rate limiter queue, as configured by dns_rate_limit_max_queue.

DNSRateLimiterImmediate

The total number of MX lookups dispatched without queueing — i.e. lookups that fit within the per-period budget — since startup or last summary reset.

DNSRateLimiterQueued

The total number of MX lookups that had to be queued to wait for a token since startup or last summary reset.

DNSRateLimiterDrained

The total number of MX lookups dispatched from the queue since startup or last summary reset.

DNSRateLimiterOverflow

The total number of MX lookups that bypassed the rate limiter because the queue was full since startup or last summary reset. A non-zero value indicates that dns_rate_limit_max_queue may be too small for the workload.

ResidentMessages

The number of message bodies held in memory.

DiskQueueProgress

The message spool in progress.

DeliveredMessages

The number of messages successfully delivered by Momentum since it was started or since the last summary reset.

FailedMessages

The number of outbound messages permanently failed since it was started or since the last summary reset.

TransientFailures

The number of outbound messages transiently failed since it was started or since the last summary reset.

RejectedMessages

The number of messages rejected by Momentum since it was started or since the last summary reset.

ReceivedMessages

The number of messages received by Momentum for deliver since it was started or since the last summary reset.

DeliveryRate

The average number of messages/second delivered (successful and unsuccessful) since Momentum was started or since the last summary reset.

ReceptionRate

The average number of messages/second received for delivery since Momentum was started or since the last summary reset.

RejectionRate

The average number of messages/second rejected since Momentum was started or since the last summary reset.

RejectionPercentage

The percentage of messages rejected by Momentum since it was started or since the last summary reset.

StatisticsLastReset

The number of seconds since statistics were reset using the "summary reset" command (see below).

Uptime

The number of seconds that Momentum has been running continuously.

Reset Statistics

You can reset the statistics used to generate this report by issuing a DELETE request to the same URL: DELETE /stats/summary. This will reset all the cumulative counters to zero and the time-based metrics will be calculated from that point forward. The output of a successful reset operation is as follows:

{
  "message": "statistics cleared"
}

See Also

Note

GET /stats/summary was first implemented in Momentum 4.4.1.

DELETE /stats/summary was first implemented in Momentum 5.2.

Was this page helpful?