Merge "Optimizations, Monitoring and Logging"
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / Shard.java
index 27744fcb8de8e5cde22c16090908850f231bfec8..63b26331a510835ae623a9feade7893938d81f84 100644 (file)
@@ -16,7 +16,10 @@ import akka.event.LoggingAdapter;
 import akka.japi.Creator;
 import akka.serialization.Serialization;
 import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
 import com.google.common.util.concurrent.ListenableFuture;
+import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
+import org.opendaylight.controller.cluster.datastore.identifiers.ShardTransactionIdentifier;
 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardMBeanFactory;
 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
@@ -48,6 +51,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import scala.concurrent.duration.FiniteDuration;
 
 import java.util.ArrayList;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -66,6 +70,7 @@ public class Shard extends RaftActor {
 
     public static final String DEFAULT_NAME = "default";
 
+    // The state of this Shard
     private final InMemoryDOMDataStore store;
 
     private final Map<Object, DOMStoreThreePhaseCommitCohort>
@@ -75,10 +80,11 @@ public class Shard extends RaftActor {
         Logging.getLogger(getContext().system(), this);
 
     // By default persistent will be true and can be turned off using the system
-    // property persistent
+    // property shard.persistent
     private final boolean persistent;
 
-    private final String name;
+    /// The name of this shard
+    private final ShardIdentifier name;
 
     private volatile SchemaContext schemaContext;
 
@@ -86,8 +92,8 @@ public class Shard extends RaftActor {
 
     private final List<ActorSelection> dataChangeListeners = new ArrayList<>();
 
-    private Shard(String name, Map<String, String> peerAddresses) {
-        super(name, peerAddresses, Optional.of(configParams));
+    private Shard(ShardIdentifier name, Map<ShardIdentifier, String> peerAddresses) {
+        super(name.toString(), mapPeerAddresses(peerAddresses), Optional.of(configParams));
 
         this.name = name;
 
@@ -95,16 +101,32 @@ public class Shard extends RaftActor {
 
         this.persistent = !"false".equals(setting);
 
-        LOG.info("Creating shard : {} persistent : {}", name, persistent);
+        LOG.info("Shard created : {} persistent : {}", name, persistent);
 
-        store = InMemoryDOMDataStoreFactory.create(name, null);
+        store = InMemoryDOMDataStoreFactory.create(name.toString(), null);
 
-        shardMBean = ShardMBeanFactory.getShardStatsMBean(name);
+        shardMBean = ShardMBeanFactory.getShardStatsMBean(name.toString());
 
     }
 
-    public static Props props(final String name,
-        final Map<String, String> peerAddresses) {
+    private static Map<String, String> mapPeerAddresses(Map<ShardIdentifier, String> peerAddresses){
+        Map<String , String> map = new HashMap<>();
+
+        for(Map.Entry<ShardIdentifier, String> entry : peerAddresses.entrySet()){
+            map.put(entry.getKey().toString(), entry.getValue());
+        }
+
+        return map;
+    }
+
+
+
+
+    public static Props props(final ShardIdentifier name,
+        final Map<ShardIdentifier, String> peerAddresses) {
+        Preconditions.checkNotNull(name, "name should not be null");
+        Preconditions.checkNotNull(peerAddresses, "peerAddresses should not be null");
+
         return Props.create(new Creator<Shard>() {
 
             @Override
@@ -142,39 +164,46 @@ public class Shard extends RaftActor {
             }
         } else if (message instanceof PeerAddressResolved) {
             PeerAddressResolved resolved = (PeerAddressResolved) message;
-            setPeerAddress(resolved.getPeerId(), resolved.getPeerAddress());
+            setPeerAddress(resolved.getPeerId().toString(), resolved.getPeerAddress());
         } else {
             super.onReceiveCommand(message);
         }
     }
 
     private ActorRef createTypedTransactionActor(
-        CreateTransaction createTransaction, String transactionId) {
+        CreateTransaction createTransaction, ShardTransactionIdentifier transactionId) {
         if (createTransaction.getTransactionType()
             == TransactionProxy.TransactionType.READ_ONLY.ordinal()) {
+
             shardMBean.incrementReadOnlyTransactionCount();
+
             return getContext().actorOf(
                 ShardTransaction
                     .props(store.newReadOnlyTransaction(), getSelf(),
-                        schemaContext), transactionId);
+                        schemaContext), transactionId.toString());
 
         } else if (createTransaction.getTransactionType()
             == TransactionProxy.TransactionType.READ_WRITE.ordinal()) {
+
             shardMBean.incrementReadWriteTransactionCount();
+
             return getContext().actorOf(
                 ShardTransaction
                     .props(store.newReadWriteTransaction(), getSelf(),
-                        schemaContext), transactionId);
+                        schemaContext), transactionId.toString());
 
 
         } else if (createTransaction.getTransactionType()
             == TransactionProxy.TransactionType.WRITE_ONLY.ordinal()) {
+
             shardMBean.incrementWriteOnlyTransactionCount();
+
             return getContext().actorOf(
                 ShardTransaction
                     .props(store.newWriteOnlyTransaction(), getSelf(),
-                        schemaContext), transactionId);
+                        schemaContext), transactionId.toString());
         } else {
+            // FIXME: This does not seem right
             throw new IllegalArgumentException(
                 "CreateTransaction message has unidentified transaction type="
                     + createTransaction.getTransactionType());
@@ -183,29 +212,27 @@ public class Shard extends RaftActor {
 
     private void createTransaction(CreateTransaction createTransaction) {
 
-        String transactionId = "shard-" + createTransaction.getTransactionId();
-        LOG.info("Creating transaction : {} ", transactionId);
+        ShardTransactionIdentifier transactionId = ShardTransactionIdentifier.builder().remoteTransactionId(createTransaction.getTransactionId()).build();
+        LOG.debug("Creating transaction : {} ", transactionId);
         ActorRef transactionActor =
             createTypedTransactionActor(createTransaction, transactionId);
 
         getSender()
             .tell(new CreateTransactionReply(
-                    Serialization.serializedActorPath(transactionActor),
-                    createTransaction.getTransactionId()).toSerializable(),
-                getSelf()
-            );
+                Serialization.serializedActorPath(transactionActor),
+                createTransaction.getTransactionId()).toSerializable(),
+                getSelf());
     }
 
     private void commit(final ActorRef sender, Object serialized) {
-        Modification modification =
-            MutableCompositeModification.fromSerializable(
-                serialized, schemaContext);
+        Modification modification = MutableCompositeModification
+            .fromSerializable(serialized, schemaContext);
         DOMStoreThreePhaseCommitCohort cohort =
             modificationToCohort.remove(serialized);
         if (cohort == null) {
-            LOG.error(
-                "Could not find cohort for modification : {}", modification);
-            LOG.info("Writing modification using a new transaction");
+            LOG.debug(
+                "Could not find cohort for modification : {}. Writing modification using a new transaction",
+                modification);
             DOMStoreReadWriteTransaction transaction =
                 store.newReadWriteTransaction();
             modification.apply(transaction);
@@ -216,32 +243,31 @@ public class Shard extends RaftActor {
                 future.get();
                 future = commitCohort.commit();
                 future.get();
-            } catch (InterruptedException e) {
-                LOG.error("Failed to commit", e);
-            } catch (ExecutionException e) {
+            } catch (InterruptedException | ExecutionException e) {
+                shardMBean.incrementFailedTransactionsCount();
                 LOG.error("Failed to commit", e);
+                return;
             }
+            //we want to just apply the recovery commit and return
+            shardMBean.incrementCommittedTransactionCount();
+            return;
         }
 
         final ListenableFuture<Void> future = cohort.commit();
-        shardMBean.incrementCommittedTransactionCount();
         final ActorRef self = getSelf();
         future.addListener(new Runnable() {
             @Override
             public void run() {
                 try {
                     future.get();
-
-                    if (sender != null) {
                         sender
                             .tell(new CommitTransactionReply().toSerializable(),
                                 self);
-                    } else {
-                        LOG.error("sender is null ???");
-                    }
+                        shardMBean.incrementCommittedTransactionCount();
+                        shardMBean.setLastCommittedTransactionTime(new Date());
                 } catch (InterruptedException | ExecutionException e) {
-                    // FIXME : Handle this properly
-                    LOG.error(e, "An exception happened when committing");
+                    shardMBean.incrementFailedTransactionsCount();
+                    sender.tell(new akka.actor.Status.Failure(e),self);
                 }
             }
         }, getContext().dispatcher());
@@ -270,7 +296,7 @@ public class Shard extends RaftActor {
     private void registerChangeListener(
         RegisterChangeListener registerChangeListener) {
 
-        LOG.debug("registerDataChangeListener for " + registerChangeListener
+        LOG.debug("registerDataChangeListener for {}", registerChangeListener
             .getPath());
 
 
@@ -302,8 +328,8 @@ public class Shard extends RaftActor {
                 DataChangeListenerRegistration.props(registration));
 
         LOG.debug(
-            "registerDataChangeListener sending reply, listenerRegistrationPath = "
-                + listenerRegistration.path().toString());
+            "registerDataChangeListener sending reply, listenerRegistrationPath = {} "
+                , listenerRegistration.path().toString());
 
         getSender()
             .tell(new RegisterChangeListenerReply(listenerRegistration.path()),
@@ -318,8 +344,7 @@ public class Shard extends RaftActor {
         getSender()
             .tell(new CreateTransactionChainReply(transactionChain.path())
                     .toSerializable(),
-                getSelf()
-            );
+                getSelf());
     }
 
     @Override protected void applyState(ActorRef clientActor, String identifier,
@@ -332,7 +357,9 @@ public class Shard extends RaftActor {
             if (modification != null) {
                 commit(clientActor, modification);
             } else {
-                LOG.error("modification is null - this is very unexpected");
+                LOG.error(
+                    "modification is null - this is very unexpected, clientActor = {}, identifier = {}",
+                    identifier, clientActor.path().toString());
             }
 
 
@@ -340,6 +367,7 @@ public class Shard extends RaftActor {
             LOG.error("Unknown state received {}", data);
         }
 
+        // Update stats
         ReplicatedLogEntry lastLogEntry = getLastLogEntry();
 
         if(lastLogEntry != null){
@@ -375,7 +403,7 @@ public class Shard extends RaftActor {
     }
 
     @Override public String persistenceId() {
-        return this.name;
+        return this.name.toString();
     }