forked from apache/pulsar
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add compacted topic metrics for TopicStats in CLI (apache#11564)
### Motivation Add below metrics to help track potential flows or examine the overall condition of compacted topics . - lastCompactionRemovedEventCount : the removed event count of last compaction - lastCompactionSucceedTimestamp : the timestamp of last succeed compaction - lastCompactionFailedTimestamp : the timestamp of last failed compaction - lastCompactionDurationTimeInMills: the duration time of last compaction These 4 metrics will be displayed in topic stats CLI : ``` ./pulsar-admin topics stats persistent://tenant/ns/topic ``` ### Documentation This patch will add metrics in CLI , which would generate doc automatically.
- Loading branch information
1 parent
a8a95a4
commit c0ef593
Showing
14 changed files
with
380 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
pulsar-broker/src/main/java/org/apache/pulsar/compaction/CompactorMXBean.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.compaction; | ||
|
|
||
| import org.apache.bookkeeper.common.annotation.InterfaceAudience; | ||
| import org.apache.bookkeeper.common.annotation.InterfaceStability; | ||
|
|
||
| /** | ||
| * JMX Bean interface for Compactor stats. | ||
| */ | ||
| @InterfaceAudience.LimitedPrivate | ||
| @InterfaceStability.Stable | ||
| public interface CompactorMXBean { | ||
|
|
||
| /** | ||
| * @return the removed event count of last compaction | ||
| */ | ||
| long getLastCompactionRemovedEventCount(String topic); | ||
|
|
||
| /** | ||
| * @return the timestamp of last succeed compaction | ||
| */ | ||
| long getLastCompactionSucceedTimestamp(String topic); | ||
|
|
||
| /** | ||
| * @return the timestamp of last failed compaction | ||
| */ | ||
| long getLastCompactionFailedTimestamp(String topic); | ||
|
|
||
| /** | ||
| * @return the duration time of last compaction | ||
| */ | ||
| long getLastCompactionDurationTimeInMills(String topic); | ||
|
|
||
| /** | ||
| * Remove metrics about this topic. | ||
| * @param topic | ||
| */ | ||
| void removeTopic(String topic); | ||
|
|
||
| } |
92 changes: 92 additions & 0 deletions
92
pulsar-broker/src/main/java/org/apache/pulsar/compaction/CompactorMXBeanImpl.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.compaction; | ||
|
|
||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.concurrent.atomic.LongAdder; | ||
|
|
||
| public class CompactorMXBeanImpl implements CompactorMXBean { | ||
|
|
||
| private final ConcurrentHashMap<String, CompactRecord> compactRecordOps = new ConcurrentHashMap<>(); | ||
|
|
||
| public void addCompactionRemovedEvent(String topic) { | ||
| compactRecordOps.computeIfAbsent(topic, k -> new CompactRecord()).addCompactionRemovedEvent(); | ||
| } | ||
|
|
||
| public void addCompactionStartOp(String topic) { | ||
| compactRecordOps.computeIfAbsent(topic, k -> new CompactRecord()).reset(); | ||
| } | ||
|
|
||
| public void addCompactionEndOp(String topic, boolean succeed) { | ||
| CompactRecord compactRecord = compactRecordOps.computeIfAbsent(topic, k -> new CompactRecord()); | ||
| compactRecord.lastCompactionDurationTimeInMills = System.currentTimeMillis() | ||
| - compactRecord.lastCompactionStartTimeOp; | ||
| compactRecord.lastCompactionRemovedEventCount = compactRecord.lastCompactionRemovedEventCountOp.longValue(); | ||
| if (succeed) { | ||
| compactRecord.lastCompactionSucceedTimestamp = System.currentTimeMillis(); | ||
| } else { | ||
| compactRecord.lastCompactionFailedTimestamp = System.currentTimeMillis(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public long getLastCompactionRemovedEventCount(String topic) { | ||
| return compactRecordOps.getOrDefault(topic, new CompactRecord()).lastCompactionRemovedEventCount; | ||
| } | ||
|
|
||
| @Override | ||
| public long getLastCompactionSucceedTimestamp(String topic) { | ||
| return compactRecordOps.getOrDefault(topic, new CompactRecord()).lastCompactionSucceedTimestamp; | ||
| } | ||
|
|
||
| @Override | ||
| public long getLastCompactionFailedTimestamp(String topic) { | ||
| return compactRecordOps.getOrDefault(topic, new CompactRecord()).lastCompactionFailedTimestamp; | ||
| } | ||
|
|
||
| @Override | ||
| public long getLastCompactionDurationTimeInMills(String topic) { | ||
| return compactRecordOps.getOrDefault(topic, new CompactRecord()).lastCompactionDurationTimeInMills; | ||
| } | ||
|
|
||
| @Override | ||
| public void removeTopic(String topic) { | ||
| compactRecordOps.remove(topic); | ||
| } | ||
|
|
||
| static class CompactRecord { | ||
|
|
||
| private long lastCompactionRemovedEventCount = 0L; | ||
| private long lastCompactionSucceedTimestamp = 0L; | ||
| private long lastCompactionFailedTimestamp = 0L; | ||
| private long lastCompactionDurationTimeInMills = 0L; | ||
|
|
||
| private LongAdder lastCompactionRemovedEventCountOp = new LongAdder(); | ||
| private long lastCompactionStartTimeOp; | ||
|
|
||
| public void addCompactionRemovedEvent() { | ||
| lastCompactionRemovedEventCountOp.increment(); | ||
| } | ||
|
|
||
| public void reset() { | ||
| lastCompactionRemovedEventCountOp.reset(); | ||
| lastCompactionStartTimeOp = System.currentTimeMillis(); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
pulsar-broker/src/test/java/org/apache/pulsar/compaction/CompactorMXBeanImplTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.compaction; | ||
|
|
||
| import org.apache.pulsar.broker.service.BrokerService; | ||
| import org.mockito.Mockito; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.concurrent.ScheduledExecutorService; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| @Test(groups = "broker-compaction") | ||
| public class CompactorMXBeanImplTest { | ||
|
|
||
| @Test | ||
| public void testSimple() throws Exception { | ||
| CompactorMXBeanImpl mxBean = new CompactorMXBeanImpl(); | ||
| String topic = "topic1"; | ||
| mxBean.addCompactionStartOp(topic); | ||
| assertEquals(mxBean.getLastCompactionRemovedEventCount(topic), 0, 0); | ||
| mxBean.addCompactionRemovedEvent(topic); | ||
| assertEquals(mxBean.getLastCompactionRemovedEventCount(topic), 0, 0); | ||
| mxBean.addCompactionEndOp(topic, true); | ||
| mxBean.addCompactionEndOp(topic, false); | ||
| assertEquals(mxBean.getLastCompactionRemovedEventCount(topic), 1, 0); | ||
| assertTrue(mxBean.getLastCompactionSucceedTimestamp(topic) > 0L); | ||
| assertTrue(mxBean.getLastCompactionFailedTimestamp(topic) > 0L); | ||
| assertTrue(mxBean.getLastCompactionDurationTimeInMills(topic) >= 0L); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.