chia7712 commented on code in PR #23994: URL: https://github.com/apache/kafka/pull/23994#discussion_r4438062668
########## server/src/test/java/org/apache/kafka/server/metrics/MetricsTest.java: ########## @@ -0,0 +1,287 @@ +/* + * 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.kafka.server.metrics; + +import org.apache.kafka.clients.consumer.ConsumerConfig; +import org.apache.kafka.clients.consumer.GroupProtocol; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.metrics.JmxReporter; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Time; +import org.apache.kafka.coordinator.group.GroupCoordinatorConfig; +import org.apache.kafka.server.config.ServerConfigs; +import org.apache.kafka.server.config.ServerLogConfigs; +import org.apache.kafka.storage.log.metrics.BrokerTopicMetrics; +import org.apache.kafka.test.TestUtils; + +import com.yammer.metrics.core.Meter; +import com.yammer.metrics.core.MetricName; +import com.yammer.metrics.core.MetricPredicate; + +import java.lang.management.ManagementFactory; +import java.nio.ByteBuffer; +import java.nio.charset.StandardCharsets; +import java.time.Duration; +import java.util.Collection; +import java.util.Map; +import java.util.Set; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +import javax.management.ObjectName; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +@ClusterTestDefaults( + types = Type.KRAFT, + brokers = 2, + serverProperties = { + @ClusterConfigProperty(key = ServerLogConfigs.NUM_PARTITIONS_CONFIG, value = "2"), + @ClusterConfigProperty(key = ServerConfigs.CONTROLLED_SHUTDOWN_ENABLE_CONFIG, value = "false"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.OFFSETS_TOPIC_REPLICATION_FACTOR_CONFIG, value = "1"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.OFFSETS_TOPIC_PARTITIONS_CONFIG, value = "5"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.GROUP_INITIAL_REBALANCE_DELAY_MS_CONFIG, value = "0"), + @ClusterConfigProperty(key = JmxReporter.EXCLUDE_CONFIG, value = MetricsTest.KAFKA_SERVER_PREFIX + "=ClusterId") + } +) +public class MetricsTest { + static final String KAFKA_SERVER_PREFIX = "kafka.server:type=KafkaServer,name"; + private static final int NUM_MESSAGES = 2; + + private final ClusterInstance cluster; + + MetricsTest(ClusterInstance cluster) { + this.cluster = cluster; + } + + @ClusterTest + public void testMetricsReporterAfterDeletingTopic() { + var topic = "test-topic-metric"; + cluster.createTopic(topic, 1, (short) 1); Review Comment: We need to produce some records first, otherwise `topicMetricGroups` never gets created and ########## server/src/test/java/org/apache/kafka/server/metrics/MetricsTest.java: ########## @@ -0,0 +1,287 @@ +/* + * 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.kafka.server.metrics; + +import org.apache.kafka.clients.consumer.ConsumerConfig; +import org.apache.kafka.clients.consumer.GroupProtocol; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.metrics.JmxReporter; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Time; +import org.apache.kafka.coordinator.group.GroupCoordinatorConfig; +import org.apache.kafka.server.config.ServerConfigs; +import org.apache.kafka.server.config.ServerLogConfigs; +import org.apache.kafka.storage.log.metrics.BrokerTopicMetrics; +import org.apache.kafka.test.TestUtils; + +import com.yammer.metrics.core.Meter; +import com.yammer.metrics.core.MetricName; +import com.yammer.metrics.core.MetricPredicate; + +import java.lang.management.ManagementFactory; +import java.nio.ByteBuffer; +import java.nio.charset.StandardCharsets; +import java.time.Duration; +import java.util.Collection; +import java.util.Map; +import java.util.Set; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +import javax.management.ObjectName; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +@ClusterTestDefaults( + types = Type.KRAFT, + brokers = 2, + serverProperties = { + @ClusterConfigProperty(key = ServerLogConfigs.NUM_PARTITIONS_CONFIG, value = "2"), + @ClusterConfigProperty(key = ServerConfigs.CONTROLLED_SHUTDOWN_ENABLE_CONFIG, value = "false"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.OFFSETS_TOPIC_REPLICATION_FACTOR_CONFIG, value = "1"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.OFFSETS_TOPIC_PARTITIONS_CONFIG, value = "5"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.GROUP_INITIAL_REBALANCE_DELAY_MS_CONFIG, value = "0"), + @ClusterConfigProperty(key = JmxReporter.EXCLUDE_CONFIG, value = MetricsTest.KAFKA_SERVER_PREFIX + "=ClusterId") + } +) +public class MetricsTest { + static final String KAFKA_SERVER_PREFIX = "kafka.server:type=KafkaServer,name"; + private static final int NUM_MESSAGES = 2; + + private final ClusterInstance cluster; + + MetricsTest(ClusterInstance cluster) { + this.cluster = cluster; + } + + @ClusterTest + public void testMetricsReporterAfterDeletingTopic() { + var topic = "test-topic-metric"; + cluster.createTopic(topic, 1, (short) 1); + cluster.deleteTopic(topic); + assertEquals(Set.of(), topicMetricGroups(topic), "Topic metrics exists after deleteTopic"); + } + + @ClusterTest + public void testBrokerTopicMetricsUnregisteredAfterDeletingTopic() throws Exception { + var topic = "test-broker-topic-metric"; + cluster.createTopic(topic, 2, (short) 1); + // Produce a few messages to create the metrics. + // Don't consume messages as it may cause metrics to be re-created causing the test to fail, see KAFKA-5238. + produceMessages(topic); + assertFalse(topicMetricGroups(topic).isEmpty(), "Topic metrics don't exist"); + cluster.brokers().values().forEach(broker -> assertNotNull(broker.brokerTopicStats().topicStats(topic))); + cluster.deleteTopic(topic); + assertEquals(Set.of(), topicMetricGroups(topic), "Topic metrics exists after deleteTopic"); + } + + @ClusterTest + public void testClusterIdMetric() { + assertEquals(1, metricCount(KAFKA_SERVER_PREFIX + "=ClusterId")); + } + + @ClusterTest + public void testBrokerStateMetric() { + assertEquals(1, metricCount(KAFKA_SERVER_PREFIX + "=BrokerState")); + } + + @ClusterTest + public void testYammerMetricsCountMetric() { + assertEquals(1, metricCount(KAFKA_SERVER_PREFIX + "=yammer-metrics-count")); + } + + @ClusterTest + public void testLinuxIoMetrics() { + // The linux-disk-* metrics exist only when I/O metrics can be collected on this platform. + int expectedCount = new LinuxIoMetricsCollector("/proc", Time.SYSTEM).usable() ? 1 : 0; + Set.of( + "linux-disk-read-bytes", + "linux-disk-write-bytes", + "linux-disk-rchar", + "linux-disk-wchar", + "linux-disk-syscr", + "linux-disk-syscw", + "linux-disk-cancelled-write-bytes" + ).forEach(name -> assertEquals(expectedCount, metricCount(KAFKA_SERVER_PREFIX + "=" + name))); + } + + @ClusterTest + public void testJMXFilter() throws Exception { + assertTrue(ManagementFactory.getPlatformMBeanServer().isRegistered( + new ObjectName("kafka.controller:type=KafkaController,name=ActiveControllerCount"))); + assertFalse(ManagementFactory.getPlatformMBeanServer().isRegistered(new ObjectName(KAFKA_SERVER_PREFIX + "=ClusterId"))); + } + + @ClusterTest + public void testUpdateJMXFilter(ClusterInstance cluster) throws Exception { + // Verify previously exposed metrics are removed and existing matching metrics are added. + cluster.brokers().values().forEach(broker -> broker.kafkaYammerMetrics().reconfigure( + Map.of(JmxReporter.EXCLUDE_CONFIG, "kafka.controller:type=KafkaController,name=ActiveControllerCount"))); + assertFalse(ManagementFactory.getPlatformMBeanServer().isRegistered( + new ObjectName("kafka.controller:type=KafkaController,name=ActiveControllerCount"))); + assertTrue(ManagementFactory.getPlatformMBeanServer().isRegistered(new ObjectName(KAFKA_SERVER_PREFIX + "=ClusterId"))); + } + + @ClusterTest + public void testGeneralBrokerTopicMetricsAreGreedilyRegistered(ClusterInstance cluster) throws Exception { + var topic = "test-broker-topic-metric"; + cluster.createTopic(topic, 2, (short) 1); + + // The broker metrics for all topics should be greedily registered. Review Comment: ditto ########## server/src/test/java/org/apache/kafka/server/metrics/MetricsTest.java: ########## @@ -0,0 +1,287 @@ +/* + * 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.kafka.server.metrics; + +import org.apache.kafka.clients.consumer.ConsumerConfig; +import org.apache.kafka.clients.consumer.GroupProtocol; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.metrics.JmxReporter; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Time; +import org.apache.kafka.coordinator.group.GroupCoordinatorConfig; +import org.apache.kafka.server.config.ServerConfigs; +import org.apache.kafka.server.config.ServerLogConfigs; +import org.apache.kafka.storage.log.metrics.BrokerTopicMetrics; +import org.apache.kafka.test.TestUtils; + +import com.yammer.metrics.core.Meter; +import com.yammer.metrics.core.MetricName; +import com.yammer.metrics.core.MetricPredicate; + +import java.lang.management.ManagementFactory; +import java.nio.ByteBuffer; +import java.nio.charset.StandardCharsets; +import java.time.Duration; +import java.util.Collection; +import java.util.Map; +import java.util.Set; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +import javax.management.ObjectName; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +@ClusterTestDefaults( + types = Type.KRAFT, + brokers = 2, + serverProperties = { + @ClusterConfigProperty(key = ServerLogConfigs.NUM_PARTITIONS_CONFIG, value = "2"), + @ClusterConfigProperty(key = ServerConfigs.CONTROLLED_SHUTDOWN_ENABLE_CONFIG, value = "false"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.OFFSETS_TOPIC_REPLICATION_FACTOR_CONFIG, value = "1"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.OFFSETS_TOPIC_PARTITIONS_CONFIG, value = "5"), Review Comment: Why do we need to set the offsets topic partitions explicitly? ########## server/src/test/java/org/apache/kafka/server/metrics/MetricsTest.java: ########## @@ -0,0 +1,287 @@ +/* + * 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.kafka.server.metrics; + +import org.apache.kafka.clients.consumer.ConsumerConfig; +import org.apache.kafka.clients.consumer.GroupProtocol; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.metrics.JmxReporter; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Time; +import org.apache.kafka.coordinator.group.GroupCoordinatorConfig; +import org.apache.kafka.server.config.ServerConfigs; +import org.apache.kafka.server.config.ServerLogConfigs; +import org.apache.kafka.storage.log.metrics.BrokerTopicMetrics; +import org.apache.kafka.test.TestUtils; + +import com.yammer.metrics.core.Meter; +import com.yammer.metrics.core.MetricName; +import com.yammer.metrics.core.MetricPredicate; + +import java.lang.management.ManagementFactory; +import java.nio.ByteBuffer; +import java.nio.charset.StandardCharsets; +import java.time.Duration; +import java.util.Collection; +import java.util.Map; +import java.util.Set; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +import javax.management.ObjectName; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +@ClusterTestDefaults( + types = Type.KRAFT, + brokers = 2, + serverProperties = { + @ClusterConfigProperty(key = ServerLogConfigs.NUM_PARTITIONS_CONFIG, value = "2"), + @ClusterConfigProperty(key = ServerConfigs.CONTROLLED_SHUTDOWN_ENABLE_CONFIG, value = "false"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.OFFSETS_TOPIC_REPLICATION_FACTOR_CONFIG, value = "1"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.OFFSETS_TOPIC_PARTITIONS_CONFIG, value = "5"), + @ClusterConfigProperty(key = GroupCoordinatorConfig.GROUP_INITIAL_REBALANCE_DELAY_MS_CONFIG, value = "0"), + @ClusterConfigProperty(key = JmxReporter.EXCLUDE_CONFIG, value = MetricsTest.KAFKA_SERVER_PREFIX + "=ClusterId") + } +) +public class MetricsTest { + static final String KAFKA_SERVER_PREFIX = "kafka.server:type=KafkaServer,name"; + private static final int NUM_MESSAGES = 2; + + private final ClusterInstance cluster; + + MetricsTest(ClusterInstance cluster) { + this.cluster = cluster; + } + + @ClusterTest + public void testMetricsReporterAfterDeletingTopic() { + var topic = "test-topic-metric"; + cluster.createTopic(topic, 1, (short) 1); + cluster.deleteTopic(topic); + assertEquals(Set.of(), topicMetricGroups(topic), "Topic metrics exists after deleteTopic"); + } + + @ClusterTest + public void testBrokerTopicMetricsUnregisteredAfterDeletingTopic() throws Exception { + var topic = "test-broker-topic-metric"; + cluster.createTopic(topic, 2, (short) 1); + // Produce a few messages to create the metrics. + // Don't consume messages as it may cause metrics to be re-created causing the test to fail, see KAFKA-5238. + produceMessages(topic); + assertFalse(topicMetricGroups(topic).isEmpty(), "Topic metrics don't exist"); + cluster.brokers().values().forEach(broker -> assertNotNull(broker.brokerTopicStats().topicStats(topic))); + cluster.deleteTopic(topic); + assertEquals(Set.of(), topicMetricGroups(topic), "Topic metrics exists after deleteTopic"); + } + + @ClusterTest + public void testClusterIdMetric() { + assertEquals(1, metricCount(KAFKA_SERVER_PREFIX + "=ClusterId")); + } + + @ClusterTest + public void testBrokerStateMetric() { + assertEquals(1, metricCount(KAFKA_SERVER_PREFIX + "=BrokerState")); + } + + @ClusterTest + public void testYammerMetricsCountMetric() { + assertEquals(1, metricCount(KAFKA_SERVER_PREFIX + "=yammer-metrics-count")); + } + + @ClusterTest + public void testLinuxIoMetrics() { + // The linux-disk-* metrics exist only when I/O metrics can be collected on this platform. + int expectedCount = new LinuxIoMetricsCollector("/proc", Time.SYSTEM).usable() ? 1 : 0; + Set.of( + "linux-disk-read-bytes", + "linux-disk-write-bytes", + "linux-disk-rchar", + "linux-disk-wchar", + "linux-disk-syscr", + "linux-disk-syscw", + "linux-disk-cancelled-write-bytes" + ).forEach(name -> assertEquals(expectedCount, metricCount(KAFKA_SERVER_PREFIX + "=" + name))); + } + + @ClusterTest + public void testJMXFilter() throws Exception { + assertTrue(ManagementFactory.getPlatformMBeanServer().isRegistered( + new ObjectName("kafka.controller:type=KafkaController,name=ActiveControllerCount"))); + assertFalse(ManagementFactory.getPlatformMBeanServer().isRegistered(new ObjectName(KAFKA_SERVER_PREFIX + "=ClusterId"))); + } + + @ClusterTest + public void testUpdateJMXFilter(ClusterInstance cluster) throws Exception { Review Comment: we don't need to declare `ClusterInstance cluster` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
