zentol commented on a change in pull request #19263: URL: https://github.com/apache/flink/pull/19263#discussion_r839413410
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/metrics/filter/DefaultMetricFilterTest.java ########## @@ -0,0 +1,192 @@ +/* + * 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.flink.runtime.metrics.filter; + +import org.apache.flink.configuration.Configuration; +import org.apache.flink.configuration.MetricOptions; +import org.apache.flink.metrics.Counter; +import org.apache.flink.metrics.Meter; +import org.apache.flink.metrics.MetricType; +import org.apache.flink.metrics.util.TestCounter; +import org.apache.flink.metrics.util.TestMeter; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.parallel.Execution; +import org.junit.jupiter.api.parallel.ExecutionMode; + +import java.util.Arrays; +import java.util.EnumSet; +import java.util.regex.Pattern; + +import static org.assertj.core.api.Assertions.assertThat; + +@Execution(ExecutionMode.CONCURRENT) +class DefaultMetricFilterTest { + + private static final Counter COUNTER = new TestCounter(); + private static final Meter METER = new TestMeter(); + + @Test + void testConvertToPatternWithoutWildcards() { + final Pattern pattern = DefaultMetricFilter.convertToPattern("numRecordsIn"); + assertThat(pattern.toString()).isEqualTo("(numRecordsIn)"); + assertThat(pattern.matcher("numRecordsIn").matches()).isEqualTo(true); + assertThat(pattern.matcher("numBytesOut").matches()).isEqualTo(false); + } + + @Test + void testConvertToPatternSingle() { + final Pattern pattern = DefaultMetricFilter.convertToPattern("numRecords*"); + assertThat(pattern.toString()).isEqualTo("(numRecords.+)"); + assertThat(pattern.matcher("numRecordsIn").matches()).isEqualTo(true); + assertThat(pattern.matcher("numBytesOut").matches()).isEqualTo(false); + } + + @Test + void testConvertToPatternMultiple() { + final Pattern pattern = DefaultMetricFilter.convertToPattern("numRecords*;numBytes*"); + assertThat(pattern.toString()).isEqualTo("(numRecords.+|numBytes.+)"); + assertThat(pattern.matcher("numRecordsIn").matches()).isEqualTo(true); + assertThat(pattern.matcher("numBytesOut").matches()).isEqualTo(true); + assertThat(pattern.matcher("numBytes").matches()).isEqualTo(false); + assertThat(pattern.matcher("hello").matches()).isEqualTo(false); + } + + @Test + void testParseMetricTypesSingle() { + final EnumSet<MetricType> types = DefaultMetricFilter.parseMetricTypes("meter"); + assertThat(types).containsExactly(MetricType.METER); + } + + @Test + void testParseMetricTypesMultiple() { + final EnumSet<MetricType> types = DefaultMetricFilter.parseMetricTypes("meter;counter"); + assertThat(types).containsExactlyInAnyOrder(MetricType.METER, MetricType.COUNTER); + } + + @Test + void testParseMetricTypesCaseIgnored() { + final EnumSet<MetricType> types = DefaultMetricFilter.parseMetricTypes("meter;CoUnTeR"); + assertThat(types).containsExactlyInAnyOrder(MetricType.METER, MetricType.COUNTER); + } + + @Test + void testFromConfigurationIncludeByScope() { + Configuration configuration = new Configuration(); + configuration.set( + MetricOptions.REPORTER_INCLUDES, Arrays.asList("include1:*:*", "include2.*:*:*")); + + final MetricFilter metricFilter = DefaultMetricFilter.fromConfiguration(configuration); + + assertThat(metricFilter.filter(COUNTER, "name", "include1")).isEqualTo(true); + assertThat(metricFilter.filter(COUNTER, "name", "include1.bar")).isEqualTo(false); + assertThat(metricFilter.filter(COUNTER, "name", "include2")).isEqualTo(false); + assertThat(metricFilter.filter(COUNTER, "name", "include2.bar")).isEqualTo(true); + } + + @Test + void testFromConfigurationIncludeByName() { + Configuration configuration = new Configuration(); + configuration.set(MetricOptions.REPORTER_INCLUDES, Arrays.asList("*:name:*")); + + final MetricFilter metricFilter = DefaultMetricFilter.fromConfiguration(configuration); + + assertThat(metricFilter.filter(COUNTER, "name", "bar")).isEqualTo(true); + assertThat(metricFilter.filter(COUNTER, "foo", "bar")).isEqualTo(false); + } + + @Test + void testFromConfigurationIncludeByType() { + Configuration configuration = new Configuration(); + configuration.set(MetricOptions.REPORTER_INCLUDES, Arrays.asList("*:*:counter")); + + final MetricFilter metricFilter = DefaultMetricFilter.fromConfiguration(configuration); + + assertThat(metricFilter.filter(COUNTER, "foo", "bar")).isEqualTo(true); + assertThat(metricFilter.filter(METER, "foo", "bar")).isEqualTo(false); + } + + @Test + void testFromConfigurationExcludeByScope() { + Configuration configuration = new Configuration(); + configuration.set(MetricOptions.REPORTER_EXCLUDES, Arrays.asList("include1", "include2.*")); + + final MetricFilter metricFilter = DefaultMetricFilter.fromConfiguration(configuration); + + assertThat(metricFilter.filter(COUNTER, "name", "include1")).isEqualTo(false); + assertThat(metricFilter.filter(COUNTER, "name", "include1.bar")).isEqualTo(true); + assertThat(metricFilter.filter(COUNTER, "name", "include2")).isEqualTo(true); + assertThat(metricFilter.filter(COUNTER, "name", "include2.bar")).isEqualTo(false); + } + + @Test + void testFromConfigurationExcludeByName() { + Configuration configuration = new Configuration(); + configuration.set(MetricOptions.REPORTER_EXCLUDES, Arrays.asList("*:faa*", "*:foo")); + + final MetricFilter metricFilter = DefaultMetricFilter.fromConfiguration(configuration); + + assertThat(metricFilter.filter(COUNTER, "name", "bar")).isEqualTo(true); + assertThat(metricFilter.filter(COUNTER, "foo", "bar")).isEqualTo(false); + assertThat(metricFilter.filter(COUNTER, "foob", "bar")).isEqualTo(true); + assertThat(metricFilter.filter(COUNTER, "faab", "bar")).isEqualTo(false); + } + + @Test + void testFromConfigurationExcludeByType() { + Configuration configuration = new Configuration(); + configuration.set(MetricOptions.REPORTER_EXCLUDES, Arrays.asList("*:*:meter")); + + final MetricFilter metricFilter = DefaultMetricFilter.fromConfiguration(configuration); + + assertThat(metricFilter.filter(COUNTER, "foo", "bar")).isEqualTo(true); + assertThat(metricFilter.filter(METER, "foo", "bar")).isEqualTo(false); + } + + @Test + void testFromConfigurationIncludeDefault() { + Configuration configuration = new Configuration(); + configuration.set(MetricOptions.REPORTER_EXCLUDES, Arrays.asList("*:*:meter")); + + final MetricFilter metricFilter = DefaultMetricFilter.fromConfiguration(configuration); + + assertThat(metricFilter.filter(COUNTER, "foo", "hello")).isEqualTo(true); + assertThat(metricFilter.filter(METER, "foo", "hello")).isEqualTo(false); + assertThat(metricFilter.filter(COUNTER, "foo", "hello")).isEqualTo(true); + } + + @Test + void testFromConfigurationExcludeDefault() { Review comment: That by default we don't exclude anything. It's not a comprehensive test (as that'd be impossible to cover I think); basic idea is to guard against mistakes like setting the default to `*`. -- 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: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
