Skip to content

EffectiveConstraints

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.

Steady-state ceilings implied by an EgressPathConfig. Each ceiling carries a tag for which configuration term produced it.

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.

These are per-queue ceilings; shared limits in additional_* maps are reported at their full value and may be tighter in practice when the bucket is contended.

This is an object value, with the following properties:

  • max_concurrent_dispatchers - required EffectiveCeiling. Steady-state ceiling for a single throughput axis, with a tag for which configuration term produced it.
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.

  • max_connection_rate - optional nullable EffectiveCeiling.

  • max_message_rate - optional nullable EffectiveCeiling.

  • max_message_rate_declared - optional nullable string. Pre-formatted display of the declared max_message_rate when a different term (typically ReconnectCycling) wins the minimum. Lets renderers show a "declared but unreachable" annotation. Uses the operator's original units.

  • max_source_selection_rate - optional nullable EffectiveCeiling.

Examples

{
  "max_concurrent_dispatchers": {
    "display": "string",
    "source": {
      "kind": "primary"
    },
    "value": 4.2
  },
  "max_connection_rate": {
    "display": "string",
    "source": {
      "kind": "primary"
    },
    "value": 4.2
  },
  "max_message_rate": {
    "display": "string",
    "source": {
      "kind": "primary"
    },
    "value": 4.2
  },
  "max_message_rate_declared": "string",
  "max_source_selection_rate": {
    "display": "string",
    "source": {
      "kind": "primary"
    },
    "value": 4.2
  }
}