org.apache.bookkeeper.client

Class ZoneawareEnsemblePlacementPolicy

java.lang.Object

org.apache.bookkeeper.client.TopologyAwareEnsemblePlacementPolicy

org.apache.bookkeeper.client.ZoneawareEnsemblePlacementPolicyImpl

org.apache.bookkeeper.client.ZoneawareEnsemblePlacementPolicy

All Implemented Interfaces:

EnsemblePlacementPolicy, ITopologyAwareEnsemblePlacementPolicy<org.apache.bookkeeper.net.BookieNode>

public class ZoneawareEnsemblePlacementPolicy
extends ZoneawareEnsemblePlacementPolicyImpl
implements ITopologyAwareEnsemblePlacementPolicy<org.apache.bookkeeper.net.BookieNode>

A placement policy implementation use zone information for placing ensembles.

See Also:

EnsemblePlacementPolicy

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.bookkeeper.client.ZoneawareEnsemblePlacementPolicyImpl

ZoneawareEnsemblePlacementPolicyImpl.ZoneAwareNodeLocation

Nested classes/interfaces inherited from class org.apache.bookkeeper.client.TopologyAwareEnsemblePlacementPolicy

TopologyAwareEnsemblePlacementPolicy.DefaultResolver, TopologyAwareEnsemblePlacementPolicy.DNSResolverDecorator, TopologyAwareEnsemblePlacementPolicy.EnsembleForReplacementWithNoConstraints, TopologyAwareEnsemblePlacementPolicy.RRTopologyAwareCoverageEnsemble, TopologyAwareEnsemblePlacementPolicy.TruePredicate

Nested classes/interfaces inherited from interface org.apache.bookkeeper.client.ITopologyAwareEnsemblePlacementPolicy

ITopologyAwareEnsemblePlacementPolicy.Ensemble<T extends org.apache.bookkeeper.net.Node>, ITopologyAwareEnsemblePlacementPolicy.Predicate<T extends org.apache.bookkeeper.net.Node>

Nested classes/interfaces inherited from interface org.apache.bookkeeper.client.EnsemblePlacementPolicy

EnsemblePlacementPolicy.PlacementPolicyAdherence, EnsemblePlacementPolicy.PlacementResult<T>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ZoneawareEnsemblePlacementPolicyImpl	slave

Fields inherited from class org.apache.bookkeeper.client.ZoneawareEnsemblePlacementPolicyImpl

address2NodePlacement, desiredNumZonesPerWriteQuorum, enforceStrictZoneawarePlacement, failedToResolveNetworkLocationCounter, LOG, maxWeightMultiple, minNumZonesPerWriteQuorum, myNode, myZone, numWritableBookiesInDefaultFaultDomain, reorderReadsRandom, reorderThresholdPendingRequests, slowBookies, stabilizePeriodSeconds, statsLogger, timer, UNKNOWN_ZONE, unresolvedNodeLocation

Fields inherited from class org.apache.bookkeeper.client.TopologyAwareEnsemblePlacementPolicy

bookieAddressResolver, bookieInfoMap, bookiesJoinedCounter, bookiesLeftCounter, dnsResolver, isWeighted, knownBookies, readOnlyBookies, REPP_DNS_RESOLVER_CLASS, rwLock, topology, weightedSelection

Constructor Summary

Constructors

Constructor and Description
ZoneawareEnsemblePlacementPolicy()

Method Summary

Modifier and Type	Method and Description
void	handleBookiesThatJoined(java.util.Set<org.apache.bookkeeper.net.BookieId> joinedBookies) Handle bookies that joined.
void	handleBookiesThatLeft(java.util.Set<org.apache.bookkeeper.net.BookieId> leftBookies) Handle bookies that left.
EnsemblePlacementPolicy	initialize(ClientConfiguration conf, java.util.Optional<org.apache.bookkeeper.net.DNSToSwitchMapping> optionalDnsResolver, io.netty.util.HashedWheelTimer timer, FeatureProvider featureProvider, org.apache.bookkeeper.stats.StatsLogger statsLogger, org.apache.bookkeeper.proto.BookieAddressResolver bookieAddressResolver) Initialize the policy.
EnsemblePlacementPolicy.PlacementResult<java.util.List<org.apache.bookkeeper.net.BookieId>>	newEnsemble(int ensembleSize, int writeQuorumSize, int ackQuorumSize, java.util.Map<java.lang.String,byte[]> customMetadata, java.util.Set<org.apache.bookkeeper.net.BookieId> excludeBookies) Choose numBookies bookies for ensemble.
java.util.Set<org.apache.bookkeeper.net.BookieId>	onClusterChanged(java.util.Set<org.apache.bookkeeper.net.BookieId> writableBookies, java.util.Set<org.apache.bookkeeper.net.BookieId> readOnlyBookies) A consistent view of the cluster (what bookies are available as writable, what bookies are available as readonly) is updated when any changes happen in the cluster.
EnsemblePlacementPolicy.PlacementResult<org.apache.bookkeeper.net.BookieId>	replaceBookie(int ensembleSize, int writeQuorumSize, int ackQuorumSize, java.util.Map<java.lang.String,byte[]> customMetadata, java.util.List<org.apache.bookkeeper.net.BookieId> currentEnsemble, org.apache.bookkeeper.net.BookieId bookieToReplace, java.util.Set<org.apache.bookkeeper.net.BookieId> excludeBookies) Choose a new bookie to replace bookieToReplace.
void	uninitalize() Uninitialize the policy.

Methods inherited from class org.apache.bookkeeper.client.ZoneawareEnsemblePlacementPolicyImpl

addDefaultFaultDomainBookies, areAckedBookiesAdheringToPlacementPolicy, getDefaultFaultDomain, getZoneAwareNodeLocation, getZoneAwareNodeLocation, isEnsembleAdheringToPlacementPolicy, newEnsemble, registerSlowBookie, reorderReadLACSequence, reorderReadSequence, selectFromNetworkLocation, selectFromNetworkLocation, selectFromNetworkLocation, withDefaultFaultDomain

Methods inherited from class org.apache.bookkeeper.client.TopologyAwareEnsemblePlacementPolicy

convertBookiesToNodes, createBookieNode, createDummyLocalBookieNode, getNetworkLocations, onBookieRackChange, resolveNetworkLocation, shuffleWithMask, updateBookieInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.bookkeeper.client.ITopologyAwareEnsemblePlacementPolicy

newEnsemble, onBookieRackChange, selectFromNetworkLocation, selectFromNetworkLocation, selectFromNetworkLocation

Methods inherited from interface org.apache.bookkeeper.client.EnsemblePlacementPolicy

areAckedBookiesAdheringToPlacementPolicy, getStickyReadBookieIndex, isEnsembleAdheringToPlacementPolicy, registerSlowBookie, reorderReadLACSequence, reorderReadSequence, updateBookieInfo

Field Detail

slave

ZoneawareEnsemblePlacementPolicyImpl slave

Constructor Detail

ZoneawareEnsemblePlacementPolicy

public ZoneawareEnsemblePlacementPolicy()

Method Detail

initialize

public EnsemblePlacementPolicy initialize(ClientConfiguration conf,
                                          java.util.Optional<org.apache.bookkeeper.net.DNSToSwitchMapping> optionalDnsResolver,
                                          io.netty.util.HashedWheelTimer timer,
                                          FeatureProvider featureProvider,
                                          org.apache.bookkeeper.stats.StatsLogger statsLogger,
                                          org.apache.bookkeeper.proto.BookieAddressResolver bookieAddressResolver)

Description copied from interface: EnsemblePlacementPolicy

Initialize the policy.

Specified by:

initialize in interface EnsemblePlacementPolicy

Overrides:

initialize in class ZoneawareEnsemblePlacementPolicyImpl

Parameters:

conf - client configuration

optionalDnsResolver - dns resolver

timer - timer

featureProvider - feature provider

statsLogger - stats logger

uninitalize

public void uninitalize()

Description copied from interface: EnsemblePlacementPolicy

Uninitialize the policy.

Specified by:

uninitalize in interface EnsemblePlacementPolicy

Overrides:

uninitalize in class ZoneawareEnsemblePlacementPolicyImpl

onClusterChanged

public java.util.Set<org.apache.bookkeeper.net.BookieId> onClusterChanged(java.util.Set<org.apache.bookkeeper.net.BookieId> writableBookies,
                                                                          java.util.Set<org.apache.bookkeeper.net.BookieId> readOnlyBookies)

Description copied from interface: EnsemblePlacementPolicy

A consistent view of the cluster (what bookies are available as writable, what bookies are available as readonly) is updated when any changes happen in the cluster.

The implementation should take actions when the cluster view is changed. So subsequent EnsemblePlacementPolicy.newEnsemble(int, int, int, Map, Set) and #replaceBookie(int, int, int, java.util.Map, java.util.Set, org.apache.bookkeeper.net.BookieSocketAddress, java.util.Set) can choose proper bookies.

Specified by:

onClusterChanged in interface EnsemblePlacementPolicy

Overrides:

onClusterChanged in class TopologyAwareEnsemblePlacementPolicy

Parameters:

writableBookies - All the bookies in the cluster available for write/read.

readOnlyBookies - All the bookies in the cluster available for readonly.

Returns:

the dead bookies during this cluster change.

newEnsemble

public EnsemblePlacementPolicy.PlacementResult<java.util.List<org.apache.bookkeeper.net.BookieId>> newEnsemble(int ensembleSize,
                                                                                                               int writeQuorumSize,
                                                                                                               int ackQuorumSize,
                                                                                                               java.util.Map<java.lang.String,byte[]> customMetadata,
                                                                                                               java.util.Set<org.apache.bookkeeper.net.BookieId> excludeBookies)
                                                                                                        throws BKException.BKNotEnoughBookiesException

Description copied from interface: EnsemblePlacementPolicy

Choose numBookies bookies for ensemble. If the count is more than the number of available nodes, BKException.BKNotEnoughBookiesException is thrown.

The implementation should respect to the replace settings. The size of the returned bookie list should be equal to the provide ensembleSize.

customMetadata is the same user defined data that user provides when BookKeeper.createLedger(int, int, int, BookKeeper.DigestType, byte[], Map).

If 'enforceMinNumRacksPerWriteQuorum' config is enabled then the bookies belonging to default faultzone (rack) will be excluded while selecting bookies.

Specified by:

newEnsemble in interface EnsemblePlacementPolicy

Overrides:

newEnsemble in class ZoneawareEnsemblePlacementPolicyImpl

Parameters:

ensembleSize - Ensemble Size

writeQuorumSize - Write Quorum Size

ackQuorumSize - the value of ackQuorumSize (added since 4.5)

customMetadata - the value of customMetadata. it is the same user defined metadata that user provides in BookKeeper.createLedger(int, int, int, BookKeeper.DigestType, byte[])

excludeBookies - Bookies that should not be considered as targets.

Returns:

a placement result containing list of bookie addresses for the ensemble.

Throws:

BKException.BKNotEnoughBookiesException - if not enough bookies available.

replaceBookie

public EnsemblePlacementPolicy.PlacementResult<org.apache.bookkeeper.net.BookieId> replaceBookie(int ensembleSize,
                                                                                                 int writeQuorumSize,
                                                                                                 int ackQuorumSize,
                                                                                                 java.util.Map<java.lang.String,byte[]> customMetadata,
                                                                                                 java.util.List<org.apache.bookkeeper.net.BookieId> currentEnsemble,
                                                                                                 org.apache.bookkeeper.net.BookieId bookieToReplace,
                                                                                                 java.util.Set<org.apache.bookkeeper.net.BookieId> excludeBookies)
                                                                                          throws BKException.BKNotEnoughBookiesException

Description copied from interface: EnsemblePlacementPolicy

Choose a new bookie to replace bookieToReplace. If no bookie available in the cluster, BKException.BKNotEnoughBookiesException is thrown.

If 'enforceMinNumRacksPerWriteQuorum' config is enabled then the bookies belonging to default faultzone (rack) will be excluded while selecting bookies.

Specified by:

replaceBookie in interface EnsemblePlacementPolicy

Overrides:

replaceBookie in class ZoneawareEnsemblePlacementPolicyImpl

Parameters:

ensembleSize - the value of ensembleSize

writeQuorumSize - the value of writeQuorumSize

ackQuorumSize - the value of ackQuorumSize (added since 4.5)

customMetadata - the value of customMetadata. it is the same user defined metadata that user provides in BookKeeper.createLedger(int, int, int, BookKeeper.DigestType, byte[])

currentEnsemble - the value of currentEnsemble

bookieToReplace - bookie to replace

excludeBookies - bookies that should not be considered as candidate.

Returns:

a placement result containing the new bookie address.

Throws:

BKException.BKNotEnoughBookiesException

handleBookiesThatLeft

public void handleBookiesThatLeft(java.util.Set<org.apache.bookkeeper.net.BookieId> leftBookies)

Description copied from interface: ITopologyAwareEnsemblePlacementPolicy

Handle bookies that left.

Specified by:

handleBookiesThatLeft in interface ITopologyAwareEnsemblePlacementPolicy<org.apache.bookkeeper.net.BookieNode>

Overrides:

handleBookiesThatLeft in class TopologyAwareEnsemblePlacementPolicy

Parameters:

leftBookies - bookies that left

handleBookiesThatJoined

public void handleBookiesThatJoined(java.util.Set<org.apache.bookkeeper.net.BookieId> joinedBookies)

Description copied from interface: ITopologyAwareEnsemblePlacementPolicy

Handle bookies that joined.

Specified by:

handleBookiesThatJoined in interface ITopologyAwareEnsemblePlacementPolicy<org.apache.bookkeeper.net.BookieNode>

Overrides:

handleBookiesThatJoined in class TopologyAwareEnsemblePlacementPolicy

Parameters:

joinedBookies - bookies that joined.