GitHub

cluster_metrics

API reference for cluster_metrics.

The metrics a cluster runner reports (Effect's ClusterMetrics).

Values

AttributeTypeDescription
entitiesGauge[int]

Active entities, per entity type.

entity_mailbox_sizeGauge[int]

Requests in an entity's mailbox, per entity (with entity_mailbox_metrics).

entity_mailbox_size_maxGauge[int]

The largest mailbox of an entity type.

singletonsGauge[int]

Singletons running on this runner.

runnersGauge[int]

Runners known to this runner.

runners_healthyGauge[int]

Whether this runner is healthy (1) or not (0).

shardsGauge[int]

Shards whose lock this runner holds.

shards_releasingGauge[int]

Shards this runner is releasing.

shard_release_durationHistogram[DurationInput]

How long releasing a shard took.