Skip to content

DispatcherSummary

Info

This page was generated by extracting information from a JSON Schema data file for the API. It may be missing some information, or otherwise suggest approximate or placeholder values based on information in the schema file; this is due to limitations on how that data is extracted from the underlying Rust code and into the JSON Schema, and then again from there and into these docs.

Per-dispatcher summary returned by the inspect-ready-q endpoint.

Since: Dev Builds Only

The functionality described in this section requires a dev build of KumoMTA. You can obtain a dev build by following the instructions in the Installation section.

This is an object value, with the following properties:

  • age - required string.

  • delivered_this_connection - required integer (u-int64).

  • detail - optional nullable string.

  • messages_delivered - required integer (u-int64).

  • messages_failed - required integer (u-int64).

  • messages_transfailed - required integer (u-int64).

  • overall_rate_per_sec - required number (double).

  • phase - required DispatcherPhase. Phase of a dispatcher task within a ready queue.

Since: Dev Builds Only

The functionality described in this section requires a dev build of KumoMTA. You can obtain a dev build by following the instructions in the Installation section.

  • session_id - required string (uuid).

  • started_at - required string (date-time).

  • time_in_current_phase - required string.

Examples

{
  "age": "string",
  "delivered_this_connection": 42,
  "detail": "string",
  "messages_delivered": 42,
  "messages_failed": 42,
  "messages_transfailed": 42,
  "overall_rate_per_sec": 4.2,
  "phase": "Starting",
  "session_id": "9511a32e-66f8-42aa-b151-ccb176df47d9",
  "started_at": "1990-12-31T23:59:60Z",
  "time_in_current_phase": "string"
}