2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore;
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;
27 * Maintains statistics for a shard.
29 * @author Basheeruddin syedbahm@cisco.com
31 final class ShardStats extends AbstractMXBean implements ShardStatsMXBean {
32 public static final String JMX_CATEGORY_SHARD = "Shards";
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");
38 private static final MapJoiner MAP_JOINER = Joiner.on(", ").withKeyValueSeparator(": ");
40 private final Shard shard;
42 private final OnDemandShardStateCache stateCache;
44 private long committedTransactionsCount;
46 private long readOnlyTransactionCount;
48 private long readWriteTransactionCount;
50 private long lastCommittedTransactionTime;
52 private long failedTransactionsCount;
54 private final AtomicLong failedReadTransactionsCount = new AtomicLong();
56 private long abortTransactionsCount;
58 private boolean followerInitialSyncStatus = false;
60 private String statRetrievalError;
62 private long leadershipChangeCount;
64 private long lastLeadershipChangeTime;
66 ShardStats(final String shardName, final String mxBeanType, final @Nullable Shard shard) {
67 super(shardName, mxBeanType, JMX_CATEGORY_SHARD);
69 stateCache = new OnDemandShardStateCache(shardName, shard != null ? shard.self() : null);
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;
79 @SuppressWarnings("checkstyle:IllegalCatch")
80 private OnDemandRaftState getOnDemandRaftState() {
82 final OnDemandRaftState state = stateCache.get();
83 statRetrievalError = null;
85 } catch (Exception e) {
86 statRetrievalError = e.getCause().toString();
87 return OnDemandRaftState.builder().build();
91 private static String formatMillis(final long timeMillis) {
92 synchronized (DATE_FORMAT) {
93 return DATE_FORMAT.format(new Date(timeMillis));
98 public String getShardName() {
99 return getMBeanName();
103 public long getCommittedTransactionsCount() {
104 return committedTransactionsCount;
108 public String getLeader() {
109 return getOnDemandRaftState().getLeader();
113 public String getRaftState() {
114 return getOnDemandRaftState().getRaftState();
118 public long getReadOnlyTransactionCount() {
119 return readOnlyTransactionCount;
123 public long getReadWriteTransactionCount() {
124 return readWriteTransactionCount;
128 public long getLastLogIndex() {
129 return getOnDemandRaftState().getLastLogIndex();
133 public long getLastLogTerm() {
134 return getOnDemandRaftState().getLastLogTerm();
138 public long getCurrentTerm() {
139 return getOnDemandRaftState().getCurrentTerm();
143 public long getCommitIndex() {
144 return getOnDemandRaftState().getCommitIndex();
148 public long getLastApplied() {
149 return getOnDemandRaftState().getLastApplied();
153 public long getLastIndex() {
154 return getOnDemandRaftState().getLastIndex();
158 public long getLastTerm() {
159 return getOnDemandRaftState().getLastTerm();
163 public long getSnapshotIndex() {
164 return getOnDemandRaftState().getSnapshotIndex();
168 public long getSnapshotTerm() {
169 return getOnDemandRaftState().getSnapshotTerm();
173 public long getReplicatedToAllIndex() {
174 return getOnDemandRaftState().getReplicatedToAllIndex();
178 public String getVotedFor() {
179 return getOnDemandRaftState().getVotedFor();
183 public boolean isVoting() {
184 return getOnDemandRaftState().isVoting();
188 public String getPeerVotingStates() {
189 return MAP_JOINER.join(getOnDemandRaftState().getPeerVotingStates());
193 public boolean isSnapshotCaptureInitiated() {
194 return getOnDemandRaftState().isSnapshotCaptureInitiated();
198 public String getLastCommittedTransactionTime() {
199 return formatMillis(lastCommittedTransactionTime);
203 public long getFailedTransactionsCount() {
204 return failedTransactionsCount;
208 public long getFailedReadTransactionsCount() {
209 return failedReadTransactionsCount.get();
213 public long getAbortTransactionsCount() {
214 return abortTransactionsCount;
217 public long incrementCommittedTransactionCount() {
218 return ++committedTransactionsCount;
221 public long incrementReadOnlyTransactionCount() {
222 return ++readOnlyTransactionCount;
225 public long incrementReadWriteTransactionCount() {
226 return ++readWriteTransactionCount;
229 public long incrementFailedTransactionsCount() {
230 return ++failedTransactionsCount;
233 public long incrementFailedReadTransactionsCount() {
234 return failedReadTransactionsCount.incrementAndGet();
237 public long incrementAbortTransactionsCount() {
238 return ++abortTransactionsCount;
241 public void setLastCommittedTransactionTime(final long lastCommittedTransactionTime) {
242 this.lastCommittedTransactionTime = lastCommittedTransactionTime;
246 public long getInMemoryJournalDataSize() {
247 return getOnDemandRaftState().getInMemoryJournalDataSize();
251 public long getInMemoryJournalLogSize() {
252 return getOnDemandRaftState().getInMemoryJournalLogSize();
256 * Resets the counters related to transactions.
259 public void resetTransactionCounters() {
260 committedTransactionsCount = 0;
262 readOnlyTransactionCount = 0;
264 readWriteTransactionCount = 0;
266 lastCommittedTransactionTime = 0;
268 failedTransactionsCount = 0;
270 failedReadTransactionsCount.set(0);
272 abortTransactionsCount = 0;
276 public void setFollowerInitialSyncStatus(final boolean followerInitialSyncStatus) {
277 this.followerInitialSyncStatus = followerInitialSyncStatus;
281 public boolean getFollowerInitialSyncStatus() {
282 return followerInitialSyncStatus;
286 public List<FollowerInfo> getFollowerInfo() {
287 return getOnDemandRaftState().getFollowerInfoList();
291 public String getPeerAddresses() {
292 return MAP_JOINER.join(getOnDemandRaftState().getPeerAddresses());
296 public String getStatRetrievalTime() {
297 getOnDemandRaftState();
298 return stateCache.getStatRetrievaelTime();
302 public String getStatRetrievalError() {
303 getOnDemandRaftState();
304 return statRetrievalError;
308 public long getLeadershipChangeCount() {
309 return leadershipChangeCount;
312 public void incrementLeadershipChangeCount() {
313 leadershipChangeCount++;
314 lastLeadershipChangeTime = System.currentTimeMillis();
318 public String getLastLeadershipChangeTime() {
319 return formatMillis(lastLeadershipChangeTime);
323 public int getPendingTxCommitQueueSize() {
324 return shard != null ? shard.getPendingTxCommitQueueSize() : -1;
328 public int getTxCohortCacheSize() {
329 return shard != null ? shard.getCohortCacheSize() : -1;
333 public void captureSnapshot() {
335 shard.getSelf().tell(new InitiateCaptureSnapshot(), ActorRef.noSender());