Skip to main content

FormationHealth

Public API contract.

detailstringrequired
detection_windowstringrequired
executor_countinteger<int32>required

Possible values: >= 0

final_logsHealthFinalLogStorerequired

Public API contract.

Possible values: [local_files]

profileHealthFormationProfilerequired

Public API contract.

Possible values: [tickr_lite]

roles object[]required
  • Array [
  • implementationHealthRoleImplementationrequired

    Public API contract.

    Possible values: [local_request_reply, local_sqlite, local_journal, local_notification, local_observation, disabled]

    protocol objectrequired

    Public API contract.

    namestringrequired
    versioninteger<int32>required

    Possible values: >= 0

    roleHealthCoordinationRolerequired

    Public API contract.

    Possible values: [command_bus, task_dispatch, task_events, task_cancellation, compaction_staging, lifecycle_work, log_staging, scope_store, scope_reader, ingress_idempotency_store, liveness_watchdog, signal_applied_notifier, executor_fleet_status, event_ingress]

  • ]
  • sqlDataPlaneSqlImplementationrequired

    Public API contract.

    Possible values: [postgres, sqlite]

    statusComponentStatusrequired

    Public API contract.

    Possible values: [healthy, degraded, unhealthy]

    substrates objectrequired

    Public API contract.

    natsbooleanrequired
    object_storebooleanrequired
    postgresbooleanrequired
    redisbooleanrequired
    sqlitebooleanrequired
    topologyHealthFormationTopologyrequired

    Public API contract.

    Possible values: [single_node]

    writer_topologyHealthWriterTopologyrequired

    Public API contract.

    Possible values: [conductor_owned]

    FormationHealth
    {
    "detail": "string",
    "detection_window": "string",
    "executor_count": 0,
    "final_logs": "local_files",
    "profile": "tickr_lite",
    "roles": [
    {
    "implementation": "local_request_reply",
    "protocol": {
    "name": "string",
    "version": 0
    },
    "role": "command_bus"
    }
    ],
    "sql": "postgres",
    "status": "healthy",
    "substrates": {
    "nats": true,
    "object_store": true,
    "postgres": true,
    "redis": true,
    "sqlite": true
    },
    "topology": "single_node",
    "writer_topology": "conductor_owned"
    }