kumomta/docs/reference/http/kumod/schemas/EffectiveCeiling.md

EffectiveCeiling

!!! 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 ceiling for a single throughput axis, with a tag for which configuration term produced it.

{{since('dev')}}

This is an object value, with the following properties:

• display - required string. Pre-formatted human display preserving the operator's original configuration units. A rate configured as 10000/hr renders here as 10000/h rather than 2.78/s. For concurrency, the integer count. For the synthetic reconnect-cycling ceiling, the formula max_deliveries_per_connection × <connection_rate>.

• source - required CeilingSource. Which configuration term produced an EffectiveCeiling.

  {{since('dev')}}

• value - required number (double). Canonical value. For rate axes: events per second; useful for numeric comparison. For concurrency: a count.

Examples

{
  "display": "string",
  "source": {
    "kind": "primary"
  },
  "value": 4.2
}