opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardStats.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore;
   9
  10 import akka.actor.ActorRef;
  11 import com.google.common.base.Joiner;
  12 import com.google.common.base.Joiner.MapJoiner;
  13 import java.text.SimpleDateFormat;
  14 import java.util.Date;
  15 import java.util.List;
  16 import java.util.concurrent.atomic.AtomicLong;
  17 import org.checkerframework.checker.lock.qual.GuardedBy;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStatsMXBean;
  21 import org.opendaylight.controller.cluster.mgmt.api.FollowerInfo;
  22 import org.opendaylight.controller.cluster.raft.base.messages.InitiateCaptureSnapshot;
  23 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
  24 import org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean;
  25
  26 /**
  27  * Maintains statistics for a shard.
  28  *
  29  * @author  Basheeruddin syedbahm@cisco.com
  30  */
  31 final class ShardStats extends AbstractMXBean implements ShardStatsMXBean {
  32     public static final String JMX_CATEGORY_SHARD = "Shards";
  33
  34     // FIXME: migrate this to Java 8 thread-safe time
  35     @GuardedBy("DATE_FORMAT")
  36     private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");
  37
  38     private static final MapJoiner MAP_JOINER = Joiner.on(", ").withKeyValueSeparator(": ");
  39
  40     private final Shard shard;
  41
  42     private final OnDemandShardStateCache stateCache;
  43
  44     private long committedTransactionsCount;
  45
  46     private long readOnlyTransactionCount;
  47
  48     private long readWriteTransactionCount;
  49
  50     private long lastCommittedTransactionTime;
  51
  52     private long failedTransactionsCount;
  53
  54     private final AtomicLong failedReadTransactionsCount = new AtomicLong();
  55
  56     private long abortTransactionsCount;
  57
  58     private boolean followerInitialSyncStatus = false;
  59
  60     private String statRetrievalError;
  61
  62     private long leadershipChangeCount;
  63
  64     private long lastLeadershipChangeTime;
  65
  66     ShardStats(final String shardName, final String mxBeanType, final @Nullable Shard shard) {
  67         super(shardName, mxBeanType, JMX_CATEGORY_SHARD);
  68         this.shard = shard;
  69         stateCache = new OnDemandShardStateCache(shardName, shard != null ? shard.self() : null);
  70     }
  71
  72     static ShardStats create(final String shardName, final String mxBeanType, final @NonNull Shard shard) {
  73         String finalMXBeanType = mxBeanType != null ? mxBeanType : "DistDataStore";
  74         ShardStats shardStatsMBeanImpl = new ShardStats(shardName, finalMXBeanType, shard);
  75         shardStatsMBeanImpl.registerMBean();
  76         return shardStatsMBeanImpl;
  77     }
  78
  79     @SuppressWarnings("checkstyle:IllegalCatch")
  80     private OnDemandRaftState getOnDemandRaftState() {
  81         try {
  82             final OnDemandRaftState state = stateCache.get();
  83             statRetrievalError = null;
  84             return state;
  85         } catch (Exception e) {
  86             statRetrievalError = e.getCause().toString();
  87             return OnDemandRaftState.builder().build();
  88         }
  89     }
  90
  91     private static String formatMillis(final long timeMillis) {
  92         synchronized (DATE_FORMAT) {
  93             return DATE_FORMAT.format(new Date(timeMillis));
  94         }
  95     }
  96
  97     @Override
  98     public String getShardName() {
  99         return getMBeanName();
 100     }
 101
 102     @Override
 103     public long getCommittedTransactionsCount() {
 104         return committedTransactionsCount;
 105     }
 106
 107     @Override
 108     public String getLeader() {
 109         return getOnDemandRaftState().getLeader();
 110     }
 111
 112     @Override
 113     public String getRaftState() {
 114         return getOnDemandRaftState().getRaftState();
 115     }
 116
 117     @Override
 118     public long getReadOnlyTransactionCount() {
 119         return readOnlyTransactionCount;
 120     }
 121
 122     @Override
 123     public long getReadWriteTransactionCount() {
 124         return readWriteTransactionCount;
 125     }
 126
 127     @Override
 128     public long getLastLogIndex() {
 129         return getOnDemandRaftState().getLastLogIndex();
 130     }
 131
 132     @Override
 133     public long getLastLogTerm() {
 134         return getOnDemandRaftState().getLastLogTerm();
 135     }
 136
 137     @Override
 138     public long getCurrentTerm() {
 139         return getOnDemandRaftState().getCurrentTerm();
 140     }
 141
 142     @Override
 143     public long getCommitIndex() {
 144         return getOnDemandRaftState().getCommitIndex();
 145     }
 146
 147     @Override
 148     public long getLastApplied() {
 149         return getOnDemandRaftState().getLastApplied();
 150     }
 151
 152     @Override
 153     public long getLastIndex() {
 154         return getOnDemandRaftState().getLastIndex();
 155     }
 156
 157     @Override
 158     public long getLastTerm() {
 159         return getOnDemandRaftState().getLastTerm();
 160     }
 161
 162     @Override
 163     public long getSnapshotIndex() {
 164         return getOnDemandRaftState().getSnapshotIndex();
 165     }
 166
 167     @Override
 168     public long getSnapshotTerm() {
 169         return getOnDemandRaftState().getSnapshotTerm();
 170     }
 171
 172     @Override
 173     public long getReplicatedToAllIndex() {
 174         return getOnDemandRaftState().getReplicatedToAllIndex();
 175     }
 176
 177     @Override
 178     public String getVotedFor() {
 179         return getOnDemandRaftState().getVotedFor();
 180     }
 181
 182     @Override
 183     public boolean isVoting() {
 184         return getOnDemandRaftState().isVoting();
 185     }
 186
 187     @Override
 188     public String getPeerVotingStates() {
 189         return MAP_JOINER.join(getOnDemandRaftState().getPeerVotingStates());
 190     }
 191
 192     @Override
 193     public boolean isSnapshotCaptureInitiated() {
 194         return getOnDemandRaftState().isSnapshotCaptureInitiated();
 195     }
 196
 197     @Override
 198     public String getLastCommittedTransactionTime() {
 199         return formatMillis(lastCommittedTransactionTime);
 200     }
 201
 202     @Override
 203     public long getFailedTransactionsCount() {
 204         return failedTransactionsCount;
 205     }
 206
 207     @Override
 208     public long getFailedReadTransactionsCount() {
 209         return failedReadTransactionsCount.get();
 210     }
 211
 212     @Override
 213     public long getAbortTransactionsCount() {
 214         return abortTransactionsCount;
 215     }
 216
 217     public long incrementCommittedTransactionCount() {
 218         return ++committedTransactionsCount;
 219     }
 220
 221     public long incrementReadOnlyTransactionCount() {
 222         return ++readOnlyTransactionCount;
 223     }
 224
 225     public long incrementReadWriteTransactionCount() {
 226         return ++readWriteTransactionCount;
 227     }
 228
 229     public long incrementFailedTransactionsCount() {
 230         return ++failedTransactionsCount;
 231     }
 232
 233     public long incrementFailedReadTransactionsCount() {
 234         return failedReadTransactionsCount.incrementAndGet();
 235     }
 236
 237     public long incrementAbortTransactionsCount() {
 238         return ++abortTransactionsCount;
 239     }
 240
 241     public void setLastCommittedTransactionTime(final long lastCommittedTransactionTime) {
 242         this.lastCommittedTransactionTime = lastCommittedTransactionTime;
 243     }
 244
 245     @Override
 246     public long getInMemoryJournalDataSize() {
 247         return getOnDemandRaftState().getInMemoryJournalDataSize();
 248     }
 249
 250     @Override
 251     public long getInMemoryJournalLogSize() {
 252         return getOnDemandRaftState().getInMemoryJournalLogSize();
 253     }
 254
 255     /**
 256      * Resets the counters related to transactions.
 257      */
 258     @Override
 259     public void resetTransactionCounters() {
 260         committedTransactionsCount = 0;
 261
 262         readOnlyTransactionCount = 0;
 263
 264         readWriteTransactionCount = 0;
 265
 266         lastCommittedTransactionTime = 0;
 267
 268         failedTransactionsCount = 0;
 269
 270         failedReadTransactionsCount.set(0);
 271
 272         abortTransactionsCount = 0;
 273
 274     }
 275
 276     public void setFollowerInitialSyncStatus(final boolean followerInitialSyncStatus) {
 277         this.followerInitialSyncStatus = followerInitialSyncStatus;
 278     }
 279
 280     @Override
 281     public boolean getFollowerInitialSyncStatus() {
 282         return followerInitialSyncStatus;
 283     }
 284
 285     @Override
 286     public List<FollowerInfo> getFollowerInfo() {
 287         return getOnDemandRaftState().getFollowerInfoList();
 288     }
 289
 290     @Override
 291     public String getPeerAddresses() {
 292         return MAP_JOINER.join(getOnDemandRaftState().getPeerAddresses());
 293     }
 294
 295     @Override
 296     public String getStatRetrievalTime() {
 297         getOnDemandRaftState();
 298         return stateCache.getStatRetrievaelTime();
 299     }
 300
 301     @Override
 302     public String getStatRetrievalError() {
 303         getOnDemandRaftState();
 304         return statRetrievalError;
 305     }
 306
 307     @Override
 308     public long getLeadershipChangeCount() {
 309         return leadershipChangeCount;
 310     }
 311
 312     public void incrementLeadershipChangeCount() {
 313         leadershipChangeCount++;
 314         lastLeadershipChangeTime = System.currentTimeMillis();
 315     }
 316
 317     @Override
 318     public String getLastLeadershipChangeTime() {
 319         return formatMillis(lastLeadershipChangeTime);
 320     }
 321
 322     @Override
 323     public int getPendingTxCommitQueueSize() {
 324         return shard != null ? shard.getPendingTxCommitQueueSize() : -1;
 325     }
 326
 327     @Override
 328     public int getTxCohortCacheSize() {
 329         return shard != null ? shard.getCohortCacheSize() : -1;
 330     }
 331
 332     @Override
 333     public void captureSnapshot() {
 334         if (shard != null) {
 335             shard.getSelf().tell(new InitiateCaptureSnapshot(), ActorRef.noSender());
 336         }
 337     }
 338 }