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
9 package org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard;
11 import akka.actor.ActorRef;
12 import akka.pattern.Patterns;
13 import akka.util.Timeout;
14 import com.google.common.base.Joiner;
15 import com.google.common.base.Joiner.MapJoiner;
16 import com.google.common.base.Stopwatch;
17 import com.google.common.cache.Cache;
18 import com.google.common.cache.CacheBuilder;
19 import java.text.SimpleDateFormat;
20 import java.util.Date;
21 import java.util.List;
22 import java.util.concurrent.TimeUnit;
23 import java.util.concurrent.atomic.AtomicLong;
24 import javax.annotation.Nullable;
25 import javax.annotation.concurrent.GuardedBy;
26 import org.opendaylight.controller.cluster.datastore.Shard;
27 import org.opendaylight.controller.cluster.raft.base.messages.InitiateCaptureSnapshot;
28 import org.opendaylight.controller.cluster.raft.client.messages.FollowerInfo;
29 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
30 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
31 import org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean;
32 import scala.concurrent.Await;
35 * Maintains statistics for a shard.
37 * @author Basheeruddin syedbahm@cisco.com
39 public class ShardStats extends AbstractMXBean implements ShardStatsMXBean {
40 public static final String JMX_CATEGORY_SHARD = "Shards";
42 @GuardedBy("DATE_FORMAT")
43 private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");
45 private static final Cache<String, OnDemandRaftState> ONDEMAND_RAFT_STATE_CACHE =
46 CacheBuilder.newBuilder().expireAfterWrite(2, TimeUnit.SECONDS).build();
48 private static final MapJoiner MAP_JOINER = Joiner.on(", ").withKeyValueSeparator(": ");
50 private long committedTransactionsCount;
52 private long readOnlyTransactionCount;
54 private long writeOnlyTransactionCount;
56 private long readWriteTransactionCount;
58 private long lastCommittedTransactionTime;
60 private long failedTransactionsCount;
62 private final AtomicLong failedReadTransactionsCount = new AtomicLong();
64 private long abortTransactionsCount;
66 private boolean followerInitialSyncStatus = false;
68 private final Shard shard;
70 private String statRetrievalError;
72 private String statRetrievalTime;
74 private long leadershipChangeCount;
76 private long lastLeadershipChangeTime;
78 public ShardStats(final String shardName, final String mxBeanType, @Nullable final Shard shard) {
79 super(shardName, mxBeanType, JMX_CATEGORY_SHARD);
83 @SuppressWarnings("checkstyle:IllegalCatch")
84 private OnDemandRaftState getOnDemandRaftState() {
85 String name = getShardName();
86 OnDemandRaftState state = ONDEMAND_RAFT_STATE_CACHE.getIfPresent(name);
88 statRetrievalError = null;
89 statRetrievalTime = null;
92 Timeout timeout = new Timeout(10, TimeUnit.SECONDS);
94 Stopwatch timer = Stopwatch.createStarted();
96 state = (OnDemandRaftState) Await.result(Patterns.ask(shard.getSelf(),
97 GetOnDemandRaftState.INSTANCE, timeout), timeout.duration());
99 statRetrievalTime = timer.stop().toString();
100 ONDEMAND_RAFT_STATE_CACHE.put(name, state);
101 } catch (Exception e) {
102 statRetrievalError = e.toString();
106 state = state != null ? state : OnDemandRaftState.builder().build();
112 private static String formatMillis(final long timeMillis) {
113 synchronized (DATE_FORMAT) {
114 return DATE_FORMAT.format(new Date(timeMillis));
119 public String getShardName() {
120 return getMBeanName();
124 public long getCommittedTransactionsCount() {
125 return committedTransactionsCount;
129 public String getLeader() {
130 return getOnDemandRaftState().getLeader();
134 public String getRaftState() {
135 return getOnDemandRaftState().getRaftState();
139 public long getReadOnlyTransactionCount() {
140 return readOnlyTransactionCount;
144 public long getWriteOnlyTransactionCount() {
145 return writeOnlyTransactionCount;
149 public long getReadWriteTransactionCount() {
150 return readWriteTransactionCount;
154 public long getLastLogIndex() {
155 return getOnDemandRaftState().getLastLogIndex();
159 public long getLastLogTerm() {
160 return getOnDemandRaftState().getLastLogTerm();
164 public long getCurrentTerm() {
165 return getOnDemandRaftState().getCurrentTerm();
169 public long getCommitIndex() {
170 return getOnDemandRaftState().getCommitIndex();
174 public long getLastApplied() {
175 return getOnDemandRaftState().getLastApplied();
179 public long getLastIndex() {
180 return getOnDemandRaftState().getLastIndex();
184 public long getLastTerm() {
185 return getOnDemandRaftState().getLastTerm();
189 public long getSnapshotIndex() {
190 return getOnDemandRaftState().getSnapshotIndex();
194 public long getSnapshotTerm() {
195 return getOnDemandRaftState().getSnapshotTerm();
199 public long getReplicatedToAllIndex() {
200 return getOnDemandRaftState().getReplicatedToAllIndex();
204 public String getVotedFor() {
205 return getOnDemandRaftState().getVotedFor();
209 public boolean isVoting() {
210 return getOnDemandRaftState().isVoting();
214 public String getPeerVotingStates() {
215 return MAP_JOINER.join(getOnDemandRaftState().getPeerVotingStates());
219 public boolean isSnapshotCaptureInitiated() {
220 return getOnDemandRaftState().isSnapshotCaptureInitiated();
224 public String getLastCommittedTransactionTime() {
225 return formatMillis(lastCommittedTransactionTime);
229 public long getFailedTransactionsCount() {
230 return failedTransactionsCount;
234 public long getFailedReadTransactionsCount() {
235 return failedReadTransactionsCount.get();
239 public long getAbortTransactionsCount() {
240 return abortTransactionsCount;
243 public long incrementCommittedTransactionCount() {
244 return ++committedTransactionsCount;
247 public long incrementReadOnlyTransactionCount() {
248 return ++readOnlyTransactionCount;
251 public long incrementWriteOnlyTransactionCount() {
252 return ++writeOnlyTransactionCount;
255 public long incrementReadWriteTransactionCount() {
256 return ++readWriteTransactionCount;
259 public long incrementFailedTransactionsCount() {
260 return ++failedTransactionsCount;
263 public long incrementFailedReadTransactionsCount() {
264 return failedReadTransactionsCount.incrementAndGet();
267 public long incrementAbortTransactionsCount() {
268 return ++abortTransactionsCount;
271 public void setLastCommittedTransactionTime(final long lastCommittedTransactionTime) {
272 this.lastCommittedTransactionTime = lastCommittedTransactionTime;
276 public long getInMemoryJournalDataSize() {
277 return getOnDemandRaftState().getInMemoryJournalDataSize();
281 public long getInMemoryJournalLogSize() {
282 return getOnDemandRaftState().getInMemoryJournalLogSize();
286 * Resets the counters related to transactions.
289 public void resetTransactionCounters() {
290 committedTransactionsCount = 0;
292 readOnlyTransactionCount = 0;
294 writeOnlyTransactionCount = 0;
296 readWriteTransactionCount = 0;
298 lastCommittedTransactionTime = 0;
300 failedTransactionsCount = 0;
302 failedReadTransactionsCount.set(0);
304 abortTransactionsCount = 0;
308 public void setFollowerInitialSyncStatus(final boolean followerInitialSyncStatus) {
309 this.followerInitialSyncStatus = followerInitialSyncStatus;
313 public boolean getFollowerInitialSyncStatus() {
314 return followerInitialSyncStatus;
318 public List<FollowerInfo> getFollowerInfo() {
319 return getOnDemandRaftState().getFollowerInfoList();
323 public String getPeerAddresses() {
324 return MAP_JOINER.join(getOnDemandRaftState().getPeerAddresses());
328 public String getStatRetrievalTime() {
329 getOnDemandRaftState();
330 return statRetrievalTime;
334 public String getStatRetrievalError() {
335 getOnDemandRaftState();
336 return statRetrievalError;
340 public long getLeadershipChangeCount() {
341 return leadershipChangeCount;
344 public void incrementLeadershipChangeCount() {
345 leadershipChangeCount++;
346 lastLeadershipChangeTime = System.currentTimeMillis();
350 public String getLastLeadershipChangeTime() {
351 return formatMillis(lastLeadershipChangeTime);
355 public int getPendingTxCommitQueueSize() {
356 return shard != null ? shard.getPendingTxCommitQueueSize() : -1;
360 public int getTxCohortCacheSize() {
361 return shard != null ? shard.getCohortCacheSize() : -1;
365 public void captureSnapshot() {
367 shard.getSelf().tell(new InitiateCaptureSnapshot(), ActorRef.noSender());