Productionize CurrentShardRegionState #27406 (#28645)

This commit is contained in:
Helena Edelson 2020-02-26 10:32:28 -08:00 committed by GitHub
parent b5ddc2f224
commit 26c333b52c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 2912 additions and 73 deletions

View file

@ -220,13 +220,14 @@ Two requests to inspect the cluster state are available:
@scala[`ShardRegion.GetShardRegionState`] @java[`ShardRegion.getShardRegionStateInstance`] which will return
a @scala[`ShardRegion.CurrentShardRegionState`] @java[`ShardRegion.ShardRegionState`] that contains
the identifiers of the shards running in a Region and what entities are alive for each of them.
the identifiers of the shards running in a Region and what entities are alive for each of them.
`ShardRegion.GetClusterShardingStats` which will query all the regions in the cluster and return
a `ShardRegion.ClusterShardingStats` containing the identifiers of the shards running in each region and a count
of entities that are alive in each shard. If any shard queries failed, for example due to timeout
if a shard was too busy to reply within the configured `akka.cluster.sharding.shard-region-query-timeout`,
`ShardRegion.ClusterShardingStats` will also include the set of shard identifiers by region that failed.
of entities that are alive in each shard.
If any shard queries failed, for example due to timeout if a shard was too busy to reply within the configured `akka.cluster.sharding.shard-region-query-timeout`,
`ShardRegion.CurrentShardRegionState` and `ShardRegion.ClusterShardingStats` will also include the set of shard identifiers by region that failed.
The type names of all started shards can be acquired via @scala[`ClusterSharding.shardTypeNames`] @java[`ClusterSharding.getShardTypeNames`].