Add MXBean to report shard registered DTCL/DCL info
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / jmx / mbeans / shard / ShardStats.java
index 4eb6a8cef96319d0ca885112c3a0812ee06e5431..5a4cc98011d146ca47b34b5dd361353b2b5c4ea3 100644 (file)
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
 package org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard;
 
-import org.opendaylight.controller.cluster.datastore.jmx.mbeans.AbstractBaseMBean;
+import akka.actor.ActorRef;
+import com.google.common.base.Joiner;
+import com.google.common.base.Joiner.MapJoiner;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.List;
+import java.util.concurrent.atomic.AtomicLong;
+import javax.annotation.Nullable;
+import javax.annotation.concurrent.GuardedBy;
+import org.opendaylight.controller.cluster.datastore.Shard;
+import org.opendaylight.controller.cluster.raft.base.messages.InitiateCaptureSnapshot;
+import org.opendaylight.controller.cluster.raft.client.messages.FollowerInfo;
+import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
+import org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean;
 
 /**
- * @author: syedbahm
+ * Maintains statistics for a shard.
+ *
+ * @author  Basheeruddin syedbahm@cisco.com
  */
-public class ShardStats extends AbstractBaseMBean implements ShardStatsMBean {
-  private  Long committedTransactionsCount;
-  private Long journalMessagesCount;
-  final private String shardName;
-  private String leader;
-  private String raftState;
+public class ShardStats extends AbstractMXBean implements ShardStatsMXBean {
+    public static final String JMX_CATEGORY_SHARD = "Shards";
+
+    @GuardedBy("DATE_FORMAT")
+    private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");
+
+    private static final MapJoiner MAP_JOINER = Joiner.on(", ").withKeyValueSeparator(": ");
+
+    private final Shard shard;
+
+    private final OnDemandShardStateCache stateCache;
+
+    private long committedTransactionsCount;
+
+    private long readOnlyTransactionCount;
+
+    private long writeOnlyTransactionCount;
+
+    private long readWriteTransactionCount;
+
+    private long lastCommittedTransactionTime;
+
+    private long failedTransactionsCount;
+
+    private final AtomicLong failedReadTransactionsCount = new AtomicLong();
+
+    private long abortTransactionsCount;
+
+    private boolean followerInitialSyncStatus = false;
+
+    private String statRetrievalError;
+
+    private long leadershipChangeCount;
+
+    private long lastLeadershipChangeTime;
+
+    public ShardStats(final String shardName, final String mxBeanType, @Nullable final Shard shard) {
+        super(shardName, mxBeanType, JMX_CATEGORY_SHARD);
+        this.shard = shard;
+        stateCache = new OnDemandShardStateCache(shardName, shard != null ? shard.self() : null);
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    private OnDemandRaftState getOnDemandRaftState() {
+        try {
+            final OnDemandRaftState state = stateCache.get();
+            statRetrievalError = null;
+            return state;
+        } catch (Exception e) {
+            statRetrievalError = e.getCause().toString();
+            return OnDemandRaftState.builder().build();
+        }
+    }
+
+    private static String formatMillis(final long timeMillis) {
+        synchronized (DATE_FORMAT) {
+            return DATE_FORMAT.format(new Date(timeMillis));
+        }
+    }
+
+    @Override
+    public String getShardName() {
+        return getMBeanName();
+    }
+
+    @Override
+    public long getCommittedTransactionsCount() {
+        return committedTransactionsCount;
+    }
+
+    @Override
+    public String getLeader() {
+        return getOnDemandRaftState().getLeader();
+    }
+
+    @Override
+    public String getRaftState() {
+        return getOnDemandRaftState().getRaftState();
+    }
+
+    @Override
+    public long getReadOnlyTransactionCount() {
+        return readOnlyTransactionCount;
+    }
+
+    @Override
+    public long getWriteOnlyTransactionCount() {
+        return writeOnlyTransactionCount;
+    }
+
+    @Override
+    public long getReadWriteTransactionCount() {
+        return readWriteTransactionCount;
+    }
+
+    @Override
+    public long getLastLogIndex() {
+        return getOnDemandRaftState().getLastLogIndex();
+    }
+
+    @Override
+    public long getLastLogTerm() {
+        return getOnDemandRaftState().getLastLogTerm();
+    }
+
+    @Override
+    public long getCurrentTerm() {
+        return getOnDemandRaftState().getCurrentTerm();
+    }
+
+    @Override
+    public long getCommitIndex() {
+        return getOnDemandRaftState().getCommitIndex();
+    }
+
+    @Override
+    public long getLastApplied() {
+        return getOnDemandRaftState().getLastApplied();
+    }
+
+    @Override
+    public long getLastIndex() {
+        return getOnDemandRaftState().getLastIndex();
+    }
+
+    @Override
+    public long getLastTerm() {
+        return getOnDemandRaftState().getLastTerm();
+    }
+
+    @Override
+    public long getSnapshotIndex() {
+        return getOnDemandRaftState().getSnapshotIndex();
+    }
+
+    @Override
+    public long getSnapshotTerm() {
+        return getOnDemandRaftState().getSnapshotTerm();
+    }
+
+    @Override
+    public long getReplicatedToAllIndex() {
+        return getOnDemandRaftState().getReplicatedToAllIndex();
+    }
+
+    @Override
+    public String getVotedFor() {
+        return getOnDemandRaftState().getVotedFor();
+    }
+
+    @Override
+    public boolean isVoting() {
+        return getOnDemandRaftState().isVoting();
+    }
+
+    @Override
+    public String getPeerVotingStates() {
+        return MAP_JOINER.join(getOnDemandRaftState().getPeerVotingStates());
+    }
+
+    @Override
+    public boolean isSnapshotCaptureInitiated() {
+        return getOnDemandRaftState().isSnapshotCaptureInitiated();
+    }
+
+    @Override
+    public String getLastCommittedTransactionTime() {
+        return formatMillis(lastCommittedTransactionTime);
+    }
+
+    @Override
+    public long getFailedTransactionsCount() {
+        return failedTransactionsCount;
+    }
+
+    @Override
+    public long getFailedReadTransactionsCount() {
+        return failedReadTransactionsCount.get();
+    }
+
+    @Override
+    public long getAbortTransactionsCount() {
+        return abortTransactionsCount;
+    }
+
+    public long incrementCommittedTransactionCount() {
+        return ++committedTransactionsCount;
+    }
+
+    public long incrementReadOnlyTransactionCount() {
+        return ++readOnlyTransactionCount;
+    }
+
+    public long incrementWriteOnlyTransactionCount() {
+        return ++writeOnlyTransactionCount;
+    }
+
+    public long incrementReadWriteTransactionCount() {
+        return ++readWriteTransactionCount;
+    }
+
+    public long incrementFailedTransactionsCount() {
+        return ++failedTransactionsCount;
+    }
+
+    public long incrementFailedReadTransactionsCount() {
+        return failedReadTransactionsCount.incrementAndGet();
+    }
+
+    public long incrementAbortTransactionsCount() {
+        return ++abortTransactionsCount;
+    }
+
+    public void setLastCommittedTransactionTime(final long lastCommittedTransactionTime) {
+        this.lastCommittedTransactionTime = lastCommittedTransactionTime;
+    }
+
+    @Override
+    public long getInMemoryJournalDataSize() {
+        return getOnDemandRaftState().getInMemoryJournalDataSize();
+    }
+
+    @Override
+    public long getInMemoryJournalLogSize() {
+        return getOnDemandRaftState().getInMemoryJournalLogSize();
+    }
 
-  ShardStats(String shardName){
-    this.shardName = shardName;
-    committedTransactionsCount =0L;
-    journalMessagesCount = 0L;
-  };
+    /**
+     * Resets the counters related to transactions.
+     */
+    @Override
+    public void resetTransactionCounters() {
+        committedTransactionsCount = 0;
 
+        readOnlyTransactionCount = 0;
 
-  @Override
-  public String getShardName() {
-    return shardName;
-  }
+        writeOnlyTransactionCount = 0;
 
-  @Override
-  public Long getCommittedTransactionsCount() {
-    return committedTransactionsCount;
-  }
+        readWriteTransactionCount = 0;
 
-  @Override
-  public Long getJournalMessagesCount() {
-    //FIXME: this will be populated once after integration with Raft stuff
-    return journalMessagesCount;
-  }
+        lastCommittedTransactionTime = 0;
 
-  @Override public String getLeader() {
-    return leader;
-  }
+        failedTransactionsCount = 0;
 
-  @Override public String getRaftState() {
-    return raftState;
-  }
+        failedReadTransactionsCount.set(0);
 
-  public Long incrementCommittedTransactionCount() {
-    return committedTransactionsCount++;
-  }
+        abortTransactionsCount = 0;
 
+    }
 
-  public void updateCommittedTransactionsCount(long currentCount){
-     committedTransactionsCount = currentCount;
+    public void setFollowerInitialSyncStatus(final boolean followerInitialSyncStatus) {
+        this.followerInitialSyncStatus = followerInitialSyncStatus;
+    }
 
-  }
+    @Override
+    public boolean getFollowerInitialSyncStatus() {
+        return followerInitialSyncStatus;
+    }
 
-  public void updateJournalMessagesCount(long currentCount){
-    journalMessagesCount  = currentCount;
+    @Override
+    public List<FollowerInfo> getFollowerInfo() {
+        return getOnDemandRaftState().getFollowerInfoList();
+    }
 
-  }
+    @Override
+    public String getPeerAddresses() {
+        return MAP_JOINER.join(getOnDemandRaftState().getPeerAddresses());
+    }
 
-  public void setLeader(String leader){
-    this.leader = leader;
-  }
+    @Override
+    public String getStatRetrievalTime() {
+        getOnDemandRaftState();
+        return stateCache.getStatRetrievaelTime();
+    }
 
-  public void setRaftState(String raftState){
-    this.raftState = raftState;
-  }
+    @Override
+    public String getStatRetrievalError() {
+        getOnDemandRaftState();
+        return statRetrievalError;
+    }
 
+    @Override
+    public long getLeadershipChangeCount() {
+        return leadershipChangeCount;
+    }
 
-  @Override
-  protected String getMBeanName() {
-    return  shardName;
-  }
+    public void incrementLeadershipChangeCount() {
+        leadershipChangeCount++;
+        lastLeadershipChangeTime = System.currentTimeMillis();
+    }
 
-  @Override
-  protected String getMBeanType() {
-    return JMX_TYPE_DISTRIBUTED_DATASTORE;
-  }
+    @Override
+    public String getLastLeadershipChangeTime() {
+        return formatMillis(lastLeadershipChangeTime);
+    }
 
-  @Override
-  protected String getMBeanCategory() {
-    return JMX_CATEGORY_SHARD;
-  }
+    @Override
+    public int getPendingTxCommitQueueSize() {
+        return shard != null ? shard.getPendingTxCommitQueueSize() : -1;
+    }
 
+    @Override
+    public int getTxCohortCacheSize() {
+        return shard != null ? shard.getCohortCacheSize() : -1;
+    }
 
+    @Override
+    public void captureSnapshot() {
+        if (shard != null) {
+            shard.getSelf().tell(new InitiateCaptureSnapshot(), ActorRef.noSender());
+        }
+    }
 }