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.Stopwatch;
16 import com.google.common.cache.Cache;
17 import com.google.common.cache.CacheBuilder;
18 import java.text.SimpleDateFormat;
19 import java.util.Date;
20 import java.util.List;
22 import java.util.concurrent.TimeUnit;
23 import java.util.concurrent.atomic.AtomicLong;
24 import javax.annotation.Nullable;
25 import org.opendaylight.controller.cluster.datastore.Shard;
26 import org.opendaylight.controller.cluster.raft.base.messages.InitiateCaptureSnapshot;
27 import org.opendaylight.controller.cluster.raft.client.messages.FollowerInfo;
28 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
29 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
30 import org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean;
31 import scala.concurrent.Await;
34 * Maintains statistics for a shard.
36 * @author Basheeruddin syedbahm@cisco.com
38 public class ShardStats extends AbstractMXBean implements ShardStatsMXBean {
39 public static final String JMX_CATEGORY_SHARD = "Shards";
41 private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");
43 private static final Cache<String, OnDemandRaftState> ONDEMAND_RAFT_STATE_CACHE =
44 CacheBuilder.newBuilder().expireAfterWrite(2, TimeUnit.SECONDS).build();
46 private long committedTransactionsCount;
48 private long readOnlyTransactionCount;
50 private long writeOnlyTransactionCount;
52 private long readWriteTransactionCount;
54 private long lastCommittedTransactionTime;
56 private long failedTransactionsCount;
58 private final AtomicLong failedReadTransactionsCount = new AtomicLong();
60 private long abortTransactionsCount;
62 private boolean followerInitialSyncStatus = false;
64 private final Shard shard;
66 private String statRetrievalError;
68 private String statRetrievalTime;
70 private long leadershipChangeCount;
72 private long lastLeadershipChangeTime;
74 public ShardStats(final String shardName, final String mxBeanType, @Nullable final Shard shard) {
75 super(shardName, mxBeanType, JMX_CATEGORY_SHARD);
79 @SuppressWarnings("checkstyle:IllegalCatch")
80 private OnDemandRaftState getOnDemandRaftState() {
81 String name = getShardName();
82 OnDemandRaftState state = ONDEMAND_RAFT_STATE_CACHE.getIfPresent(name);
84 statRetrievalError = null;
85 statRetrievalTime = null;
88 Timeout timeout = new Timeout(10, TimeUnit.SECONDS);
90 Stopwatch timer = Stopwatch.createStarted();
92 state = (OnDemandRaftState) Await.result(Patterns.ask(shard.getSelf(),
93 GetOnDemandRaftState.INSTANCE, timeout), timeout.duration());
95 statRetrievalTime = timer.stop().toString();
96 ONDEMAND_RAFT_STATE_CACHE.put(name, state);
97 } catch (Exception e) {
98 statRetrievalError = e.toString();
102 state = state != null ? state : OnDemandRaftState.builder().build();
109 public String getShardName() {
110 return getMBeanName();
114 public long getCommittedTransactionsCount() {
115 return committedTransactionsCount;
119 public String getLeader() {
120 return getOnDemandRaftState().getLeader();
124 public String getRaftState() {
125 return getOnDemandRaftState().getRaftState();
129 public long getReadOnlyTransactionCount() {
130 return readOnlyTransactionCount;
134 public long getWriteOnlyTransactionCount() {
135 return writeOnlyTransactionCount;
139 public long getReadWriteTransactionCount() {
140 return readWriteTransactionCount;
144 public long getLastLogIndex() {
145 return getOnDemandRaftState().getLastLogIndex();
149 public long getLastLogTerm() {
150 return getOnDemandRaftState().getLastLogTerm();
154 public long getCurrentTerm() {
155 return getOnDemandRaftState().getCurrentTerm();
159 public long getCommitIndex() {
160 return getOnDemandRaftState().getCommitIndex();
164 public long getLastApplied() {
165 return getOnDemandRaftState().getLastApplied();
169 public long getLastIndex() {
170 return getOnDemandRaftState().getLastIndex();
174 public long getLastTerm() {
175 return getOnDemandRaftState().getLastTerm();
179 public long getSnapshotIndex() {
180 return getOnDemandRaftState().getSnapshotIndex();
184 public long getSnapshotTerm() {
185 return getOnDemandRaftState().getSnapshotTerm();
189 public long getReplicatedToAllIndex() {
190 return getOnDemandRaftState().getReplicatedToAllIndex();
194 public String getVotedFor() {
195 return getOnDemandRaftState().getVotedFor();
199 public boolean isVoting() {
200 return getOnDemandRaftState().isVoting();
204 public String getPeerVotingStates() {
205 return toStringMap(getOnDemandRaftState().getPeerVotingStates());
209 public boolean isSnapshotCaptureInitiated() {
210 return getOnDemandRaftState().isSnapshotCaptureInitiated();
214 public String getLastCommittedTransactionTime() {
215 synchronized (DATE_FORMAT) {
216 return DATE_FORMAT.format(new Date(lastCommittedTransactionTime));
221 public long getFailedTransactionsCount() {
222 return failedTransactionsCount;
226 public long getFailedReadTransactionsCount() {
227 return failedReadTransactionsCount.get();
231 public long getAbortTransactionsCount() {
232 return abortTransactionsCount;
235 public long incrementCommittedTransactionCount() {
236 return ++committedTransactionsCount;
239 public long incrementReadOnlyTransactionCount() {
240 return ++readOnlyTransactionCount;
243 public long incrementWriteOnlyTransactionCount() {
244 return ++writeOnlyTransactionCount;
247 public long incrementReadWriteTransactionCount() {
248 return ++readWriteTransactionCount;
251 public long incrementFailedTransactionsCount() {
252 return ++failedTransactionsCount;
255 public long incrementFailedReadTransactionsCount() {
256 return failedReadTransactionsCount.incrementAndGet();
259 public long incrementAbortTransactionsCount() {
260 return ++abortTransactionsCount;
263 public void setLastCommittedTransactionTime(final long lastCommittedTransactionTime) {
264 this.lastCommittedTransactionTime = lastCommittedTransactionTime;
268 public long getInMemoryJournalDataSize() {
269 return getOnDemandRaftState().getInMemoryJournalDataSize();
273 public long getInMemoryJournalLogSize() {
274 return getOnDemandRaftState().getInMemoryJournalLogSize();
278 * Resets the counters related to transactions.
281 public void resetTransactionCounters() {
282 committedTransactionsCount = 0;
284 readOnlyTransactionCount = 0;
286 writeOnlyTransactionCount = 0;
288 readWriteTransactionCount = 0;
290 lastCommittedTransactionTime = 0;
292 failedTransactionsCount = 0;
294 failedReadTransactionsCount.set(0);
296 abortTransactionsCount = 0;
300 public void setFollowerInitialSyncStatus(boolean followerInitialSyncStatus) {
301 this.followerInitialSyncStatus = followerInitialSyncStatus;
305 public boolean getFollowerInitialSyncStatus() {
306 return followerInitialSyncStatus;
310 public List<FollowerInfo> getFollowerInfo() {
311 return getOnDemandRaftState().getFollowerInfoList();
315 public String getPeerAddresses() {
316 return toStringMap(getOnDemandRaftState().getPeerAddresses());
319 private static String toStringMap(Map<?, ?> map) {
320 return Joiner.on(", ").withKeyValueSeparator(": ").join(map);
324 public String getStatRetrievalTime() {
325 getOnDemandRaftState();
326 return statRetrievalTime;
330 public String getStatRetrievalError() {
331 getOnDemandRaftState();
332 return statRetrievalError;
336 public long getLeadershipChangeCount() {
337 return leadershipChangeCount;
340 public void incrementLeadershipChangeCount() {
341 leadershipChangeCount++;
342 lastLeadershipChangeTime = System.currentTimeMillis();
346 public String getLastLeadershipChangeTime() {
347 synchronized (DATE_FORMAT) {
348 return DATE_FORMAT.format(new Date(lastLeadershipChangeTime));
353 public int getPendingTxCommitQueueSize() {
354 return shard != null ? shard.getPendingTxCommitQueueSize() : -1;
358 public int getTxCohortCacheSize() {
359 return shard != null ? shard.getCohortCacheSize() : -1;
363 public void captureSnapshot() {
365 shard.getSelf().tell(new InitiateCaptureSnapshot(), ActorRef.noSender());