Ngone51 commented on a change in pull request #33116: URL: https://github.com/apache/spark/pull/33116#discussion_r674127843
########## File path: common/network-common/src/main/java/org/apache/spark/network/util/TimerWithCustomTimeUnit.java ########## @@ -0,0 +1,117 @@ +/* + * 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.spark.network.util; + +import java.io.OutputStream; +import java.io.PrintWriter; +import java.util.concurrent.TimeUnit; + +import com.codahale.metrics.Snapshot; +import com.codahale.metrics.Timer; + +/** + * A custom version of a {@link Timer} which allows for specifying a specific {@link TimeUnit} to + * be used when accessing timing values via {@link #getSnapshot()}. Normally, though the + * {@link #update(long, TimeUnit)} method requires a unit, the extraction methods on the snapshot + * do not specify a unit, and always return nanoseconds. It can be useful to specify that a timer + * should use a different unit for its snapshot. Note that internally, all values are still stored + * with nanosecond-precision; it is only before being returned to the caller that the nanosecond + * value is converted to a millisecond value. Review comment: converted to the expected value basing on the time unit? ########## File path: common/network-yarn/src/main/java/org/apache/spark/network/yarn/YarnShuffleServiceMetrics.java ########## @@ -84,13 +83,13 @@ public static void collectMetric( .addGauge(new ShuffleServiceMetricsInfo(name + "_rateMean", "Mean rate of timer " + name), t.getMeanRate()) .addGauge( - getShuffleServiceMetricsInfoForGenericValue(timingName, "max"), snapshot.getMax()) + getShuffleServiceMetricsInfoForGenericValue(name, "max"), snapshot.getMax()) Review comment: I'm not familiar with the metrics part. Just wonder, will the naming change break the backward compatibility? ########## File path: common/network-common/src/test/java/org/apache/spark/network/util/TimerWithCustomUnitSuite.java ########## @@ -0,0 +1,76 @@ +/* + * 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.spark.network.util; + +import java.time.Duration; +import java.util.Arrays; +import java.util.concurrent.TimeUnit; + +import com.codahale.metrics.Snapshot; +import com.codahale.metrics.Timer; +import org.junit.Test; + +import static org.junit.Assert.assertArrayEquals; +import static org.junit.Assert.assertEquals; + +/** Tests for {@link TimerWithCustomTimeUnit} */ +public class TimerWithCustomUnitSuite { + + @Test + public void testTimerWithMillisecondTimeUnit() { + testTimerWithCustomTimeUnit(TimeUnit.MILLISECONDS); + } + + @Test + public void testTimerWithNanosecondTimeUnit() { + testTimerWithCustomTimeUnit(TimeUnit.NANOSECONDS); + } + + private void testTimerWithCustomTimeUnit(TimeUnit timeUnit) { + Timer timer = new TimerWithCustomTimeUnit(timeUnit); + Duration[] durations = { + Duration.ofNanos(1), + Duration.ofMillis(1), + Duration.ofMillis(5), + Duration.ofMillis(100), + Duration.ofSeconds(10) + }; + Arrays.stream(durations).forEach(timer::update); Review comment: Could you also test the `Timer.Context` APIs together since we use it in our code, e.g., https://github.com/apache/spark/blob/3255511d52f0c9652b34de4f499ee5081f59e0a5/common/network-shuffle/src/main/java/org/apache/spark/network/shuffle/ExternalBlockHandler.java#L142 ########## File path: common/network-common/src/main/java/org/apache/spark/network/util/TimerWithCustomTimeUnit.java ########## @@ -0,0 +1,117 @@ +/* + * 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.spark.network.util; + +import java.io.OutputStream; +import java.io.PrintWriter; +import java.util.concurrent.TimeUnit; + +import com.codahale.metrics.Snapshot; +import com.codahale.metrics.Timer; + +/** + * A custom version of a {@link Timer} which allows for specifying a specific {@link TimeUnit} to + * be used when accessing timing values via {@link #getSnapshot()}. Normally, though the + * {@link #update(long, TimeUnit)} method requires a unit, the extraction methods on the snapshot + * do not specify a unit, and always return nanoseconds. It can be useful to specify that a timer + * should use a different unit for its snapshot. Note that internally, all values are still stored + * with nanosecond-precision; it is only before being returned to the caller that the nanosecond + * value is converted to a millisecond value. + */ +public class TimerWithCustomTimeUnit extends Timer { + + private final TimeUnit timeUnit; + private final double nanosPerUnit; + + public TimerWithCustomTimeUnit(TimeUnit timeUnit) { + this.timeUnit = timeUnit; + this.nanosPerUnit = timeUnit.toNanos(1); + } + + @Override + public Snapshot getSnapshot() { + return new SnapshotWithCustomTimeUnit(super.getSnapshot()); + } + + private double toUnit(double nanos) { + // TimeUnit.convert() truncates (loses precision), so floating-point division is used instead + return nanos / nanosPerUnit; + } + + private long toUnit(long nanos) { + return timeUnit.convert(nanos, TimeUnit.NANOSECONDS); + } + + private class SnapshotWithCustomTimeUnit extends Snapshot { + + private final Snapshot wrappedSnapshot; + + SnapshotWithCustomTimeUnit(Snapshot wrappedSnapshot) { + this.wrappedSnapshot = wrappedSnapshot; + } + + @Override + public double getValue(double v) { + return toUnit(wrappedSnapshot.getValue(v)); + } + + @Override + public long[] getValues() { + long[] nanoValues = wrappedSnapshot.getValues(); + long[] milliValues = new long[nanoValues.length]; Review comment: Maybe, `customTimeUnitValues`? -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
