src/main/java/org/apache/gossip/manager/DatacenterRackAwareActiveGossiper.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.gossip.manager;

import java.util.List;
import java.util.ArrayList;
import java.util.Collections;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;

import org.apache.gossip.LocalGossipMember;

import com.codahale.metrics.MetricRegistry;

/**
 * Sends gossip traffic at different rates to other racks and data-centers.
 * This implementation controls the rate at which gossip traffic is shared. 
 * There are two constructs Datacenter and Rack. It is assumed that bandwidth and latency is higher
 * in the rack than in the the datacenter. We can adjust the rate at which we send messages to each group.
 * 
 */
public class DatacenterRackAwareActiveGossiper extends AbstractActiveGossiper {

  public static final String DATACENTER = "datacenter";
  public static final String RACK = "rack";
  
  private int sameRackGossipIntervalMs = 100;
  private int sameDcGossipIntervalMs = 500;
  private int differentDatacenterGossipIntervalMs = 1000;
  private int randomDeadMemberSendIntervalMs = 250;
  
  private ScheduledExecutorService scheduledExecutorService;
  private final BlockingQueue<Runnable> workQueue;
  private ThreadPoolExecutor threadService;
  
  public DatacenterRackAwareActiveGossiper(GossipManager gossipManager, GossipCore gossipCore,
          MetricRegistry registry) {
    super(gossipManager, gossipCore, registry);
    scheduledExecutorService = Executors.newScheduledThreadPool(2);
    workQueue = new ArrayBlockingQueue<Runnable>(1024);
    threadService = new ThreadPoolExecutor(1, 30, 1, TimeUnit.SECONDS, workQueue,
            new ThreadPoolExecutor.DiscardOldestPolicy());
    try {
      sameRackGossipIntervalMs = Integer.parseInt(gossipManager.getSettings()
              .getActiveGossipProperties().get("sameRackGossipIntervalMs"));
    } catch (RuntimeException ex) { }
    try {
      sameDcGossipIntervalMs = Integer.parseInt(gossipManager.getSettings()
              .getActiveGossipProperties().get("sameDcGossipIntervalMs"));
    } catch (RuntimeException ex) { }
    try {
      differentDatacenterGossipIntervalMs = Integer.parseInt(gossipManager.getSettings()
              .getActiveGossipProperties().get("differentDatacenterGossipIntervalMs"));
    } catch (RuntimeException ex) { }
    try {
      randomDeadMemberSendIntervalMs = Integer.parseInt(gossipManager.getSettings()
              .getActiveGossipProperties().get("randomDeadMemberSendIntervalMs"));
    } catch (RuntimeException ex) { }
  }

  @Override
  public void init() {
    super.init();
    //same rack
    scheduledExecutorService.scheduleAtFixedRate(() -> 
      threadService.execute(() -> sendToSameRackMember()), 
      0, sameRackGossipIntervalMs, TimeUnit.MILLISECONDS);
    
    scheduledExecutorService.scheduleAtFixedRate(() -> 
      threadService.execute(() -> sendToSameRackMemberPerNode()), 
      0, sameRackGossipIntervalMs, TimeUnit.MILLISECONDS);
    
    scheduledExecutorService.scheduleAtFixedRate(() -> 
      threadService.execute(() -> sendToSameRackShared()), 
      0, sameRackGossipIntervalMs, TimeUnit.MILLISECONDS);
    
    //same dc different rack
    scheduledExecutorService.scheduleAtFixedRate(() -> 
      threadService.execute(() -> sameDcDiffernetRackMember()), 
      0, sameDcGossipIntervalMs, TimeUnit.MILLISECONDS);
    
    scheduledExecutorService.scheduleAtFixedRate(() -> 
    threadService.execute(() -> sameDcDiffernetRackPerNode()), 
    0, sameDcGossipIntervalMs, TimeUnit.MILLISECONDS);
    
    scheduledExecutorService.scheduleAtFixedRate(() -> 
    threadService.execute(() -> sameDcDiffernetRackShared()), 
    0, sameDcGossipIntervalMs, TimeUnit.MILLISECONDS);
    
    //different dc
    scheduledExecutorService.scheduleAtFixedRate(() -> 
      threadService.execute(() -> differentDcMember()), 
      0, differentDatacenterGossipIntervalMs, TimeUnit.MILLISECONDS);
    
    scheduledExecutorService.scheduleAtFixedRate(() -> 
    threadService.execute(() -> differentDcPerNode()), 
    0, differentDatacenterGossipIntervalMs, TimeUnit.MILLISECONDS);
  
    scheduledExecutorService.scheduleAtFixedRate(() -> 
    threadService.execute(() -> differentDcShared()), 
    0, differentDatacenterGossipIntervalMs, TimeUnit.MILLISECONDS);
    
    //the dead
    scheduledExecutorService.scheduleAtFixedRate(() -> 
      threadService.execute(() -> sendToDeadMember()), 
      0, randomDeadMemberSendIntervalMs, TimeUnit.MILLISECONDS);
    
  }

  private void sendToDeadMember() {
    sendMembershipList(gossipManager.getMyself(), selectPartner(gossipManager.getDeadMembers()));
  }
  
  private List<LocalGossipMember> differentDataCenter(){
    String myDc = gossipManager.getMyself().getProperties().get(DATACENTER);
    String rack = gossipManager.getMyself().getProperties().get(RACK);
    if (myDc == null|| rack == null){
      return Collections.emptyList();
    }
    List<LocalGossipMember> notMyDc = new ArrayList<LocalGossipMember>(10);
    for (LocalGossipMember i : gossipManager.getLiveMembers()){
      if (!myDc.equals(i.getProperties().get(DATACENTER))){
        notMyDc.add(i);
      }
    }
    return notMyDc;
  }
  
  private List<LocalGossipMember> sameDatacenterDifferentRack(){
    String myDc = gossipManager.getMyself().getProperties().get(DATACENTER);
    String rack = gossipManager.getMyself().getProperties().get(RACK);
    if (myDc == null|| rack == null){
      return Collections.emptyList();
    }
    List<LocalGossipMember> notMyDc = new ArrayList<LocalGossipMember>(10);
    for (LocalGossipMember i : gossipManager.getLiveMembers()){
      if (myDc.equals(i.getProperties().get(DATACENTER)) && !rack.equals(i.getProperties().get(RACK))){
        notMyDc.add(i);
      }
    }
    return notMyDc;
  }
    
  private List<LocalGossipMember> sameRackNodes(){
    String myDc = gossipManager.getMyself().getProperties().get(DATACENTER);
    String rack = gossipManager.getMyself().getProperties().get(RACK);
    if (myDc == null|| rack == null){
      return Collections.emptyList();
    }
    List<LocalGossipMember> sameDcAndRack = new ArrayList<LocalGossipMember>(10);
    for (LocalGossipMember i : gossipManager.getLiveMembers()){
      if (myDc.equals(i.getProperties().get(DATACENTER))
              && rack.equals(i.getProperties().get(RACK))){
        sameDcAndRack.add(i);
      }
    }
    return sameDcAndRack;
  }

  private void sendToSameRackMember() {
    LocalGossipMember i = selectPartner(sameRackNodes());
    sendMembershipList(gossipManager.getMyself(), i);
  }
  
  private void sendToSameRackMemberPerNode() {
    sendPerNodeData(gossipManager.getMyself(), selectPartner(sameRackNodes()));
  }
  
  private void sendToSameRackShared() {
    sendSharedData(gossipManager.getMyself(), selectPartner(sameRackNodes()));
  }
  
  private void differentDcMember() {
    sendMembershipList(gossipManager.getMyself(), selectPartner(differentDataCenter()));
  }
  
  private void differentDcPerNode() {
    sendPerNodeData(gossipManager.getMyself(), selectPartner(differentDataCenter()));
  }
  
  private void differentDcShared() {
    sendSharedData(gossipManager.getMyself(), selectPartner(differentDataCenter()));
  }
  
  private void sameDcDiffernetRackMember() {
    sendMembershipList(gossipManager.getMyself(), selectPartner(sameDatacenterDifferentRack()));
  }
  
  private void sameDcDiffernetRackPerNode() {
    sendPerNodeData(gossipManager.getMyself(), selectPartner(sameDatacenterDifferentRack()));
  }
  
  private void sameDcDiffernetRackShared() {
    sendSharedData(gossipManager.getMyself(), selectPartner(sameDatacenterDifferentRack()));
  }
  
  @Override
  public void shutdown() {
    super.shutdown();
    scheduledExecutorService.shutdown();
    try {
      scheduledExecutorService.awaitTermination(5, TimeUnit.SECONDS);
    } catch (InterruptedException e) {
      LOGGER.debug("Issue during shutdown", e);
    }
    sendShutdownMessage();
    threadService.shutdown();
    try {
      threadService.awaitTermination(5, TimeUnit.SECONDS);
    } catch (InterruptedException e) {
      LOGGER.debug("Issue during shutdown", e);
    }
  }
  
  /**
   * sends an optimistic shutdown message to several clusters nodes
   */
  protected void sendShutdownMessage(){
    List<LocalGossipMember> l = gossipManager.getLiveMembers();
    int sendTo = l.size() < 3 ? 1 : l.size() / 3;
    for (int i = 0; i < sendTo; i++) {
      threadService.execute(() -> sendShutdownMessage(gossipManager.getMyself(), selectPartner(l)));
    }
  }
}