m-trieu commented on code in PR #30769: URL: https://github.com/apache/beam/pull/30769#discussion_r1544785415
########## runners/google-cloud-dataflow-java/worker/src/test/java/org/apache/beam/runners/dataflow/worker/LockFreeHistogramTest.java: ########## @@ -0,0 +1,182 @@ +/* + * 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.beam.runners.dataflow.worker; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.equalTo; + +import java.util.Optional; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; +import org.apache.beam.sdk.metrics.MetricName; +import org.apache.beam.sdk.util.HistogramData; +import org.apache.beam.sdk.values.KV; +import org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.primitives.ImmutableLongArray; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +/** Tests for {@link LockFreeHistogram}. */ +@RunWith(JUnit4.class) +public class LockFreeHistogramTest { + + @Test + public void testUpdate_OverflowValues() { + HistogramData.BucketType bucketType = HistogramData.LinearBuckets.of(0, 10, 3); + LockFreeHistogram histogram = + new LockFreeHistogram(KV.of(MetricName.named("name", "namespace"), bucketType)); + histogram.update(35, 40, 45); + Optional<LockFreeHistogram.Snapshot> snapshot = histogram.getSnapshotAndReset(); + + LockFreeHistogram.OutlierStatistic expectedOverflow = + LockFreeHistogram.OutlierStatistic.create(120.0, 3L); + LockFreeHistogram.OutlierStatistic expectedUnderflow = LockFreeHistogram.OutlierStatistic.EMPTY; + ImmutableLongArray expectedBuckets = ImmutableLongArray.of(0L, 0L, 0L); + LockFreeHistogram.Snapshot expectedSnapshot = + LockFreeHistogram.Snapshot.create( + expectedUnderflow, expectedOverflow, expectedBuckets, bucketType); + + assertThat(snapshot.isPresent(), equalTo(true)); + assertThat(snapshot.get(), equalTo(expectedSnapshot)); + assertThat(snapshot.get().underflowStatistic().mean(), equalTo(0.0)); + assertThat(snapshot.get().overflowStatistic(), equalTo(expectedOverflow)); + } + + @Test + public void testUpdate_UnderflowValues() { + HistogramData.BucketType bucketType = HistogramData.LinearBuckets.of(100, 10, 3); + LockFreeHistogram histogram = + new LockFreeHistogram(KV.of(MetricName.named("name", "namespace"), bucketType)); + histogram.update(35, 40, 45); + Optional<LockFreeHistogram.Snapshot> snapshot = histogram.getSnapshotAndReset(); + + LockFreeHistogram.OutlierStatistic expectedUnderflow = + LockFreeHistogram.OutlierStatistic.create(120.0, 3L); + LockFreeHistogram.OutlierStatistic expectedOverflow = LockFreeHistogram.OutlierStatistic.EMPTY; + ImmutableLongArray expectedBuckets = ImmutableLongArray.of(0L, 0L, 0L); + LockFreeHistogram.Snapshot expectedSnapshot = + LockFreeHistogram.Snapshot.create( + expectedUnderflow, expectedOverflow, expectedBuckets, bucketType); + + assertThat(snapshot.isPresent(), equalTo(true)); + assertThat(snapshot.get(), equalTo(expectedSnapshot)); + assertThat(snapshot.get().underflowStatistic(), equalTo(expectedUnderflow)); + } + + @Test + public void testUpdate_InBoundsValues() { + HistogramData.BucketType bucketType = HistogramData.LinearBuckets.of(0, 10, 3); + LockFreeHistogram histogram = + new LockFreeHistogram(KV.of(MetricName.named("name", "namespace"), bucketType)); + histogram.update(5, 15, 25); + Optional<LockFreeHistogram.Snapshot> snapshot = histogram.getSnapshotAndReset(); + + LockFreeHistogram.OutlierStatistic expectedOverflow = LockFreeHistogram.OutlierStatistic.EMPTY; + LockFreeHistogram.OutlierStatistic expectedUnderflow = LockFreeHistogram.OutlierStatistic.EMPTY; + ImmutableLongArray expectedBuckets = ImmutableLongArray.of(1L, 1L, 1L); + LockFreeHistogram.Snapshot expectedSnapshot = + LockFreeHistogram.Snapshot.create( + expectedUnderflow, expectedOverflow, expectedBuckets, bucketType); + + assertThat(snapshot.isPresent(), equalTo(true)); + assertThat(snapshot.get(), equalTo(expectedSnapshot)); + } + + @Test + public void testUpdate_EmptySnapshot() { + HistogramData.BucketType bucketType = HistogramData.LinearBuckets.of(0, 10, 3); + LockFreeHistogram histogram = + new LockFreeHistogram(KV.of(MetricName.named("name", "namespace"), bucketType)); + histogram.update(5, 15, 25); + Optional<LockFreeHistogram.Snapshot> snapshot_1 = histogram.getSnapshotAndReset(); + + assertThat(snapshot_1.isPresent(), equalTo(true)); + + Optional<LockFreeHistogram.Snapshot> snapshot_2 = histogram.getSnapshotAndReset(); + assertThat(snapshot_2.isPresent(), equalTo(false)); + } + + /** A runnable records 200 values and then calls getSnapshotAndReset. */ + private static class UpdateHistogramRunnable implements Runnable { + private final LockFreeHistogram histogram; + private final int val; + private Optional<LockFreeHistogram.Snapshot> snapshot; + + private static final long valuesRecorded = 200L; + + public UpdateHistogramRunnable(LockFreeHistogram histogram, int val) { + this.histogram = histogram; + this.val = val; + this.snapshot = Optional.empty(); + } + + @Override + public void run() { + for (long j = 0; j < valuesRecorded; j++) { + histogram.update(val); + } + snapshot = histogram.getSnapshotAndReset(); + } + + public long totalCountInSnapshot() { + if (snapshot.isPresent()) { + return snapshot.get().totalCount(); + } + return 0; + } + + public static long numValuesRecorded() { + return valuesRecorded; + } + } + + @Test + public void testUpdateAndSnapshots_MultipleThreads() { + int numRunnables = 200; + ExecutorService executor = Executors.newFixedThreadPool(numRunnables); + HistogramData.BucketType bucketType = HistogramData.ExponentialBuckets.of(1, 10); + LockFreeHistogram histogram = + new LockFreeHistogram(KV.of(MetricName.named("name", "namespace"), bucketType)); + + UpdateHistogramRunnable[] runnables = new UpdateHistogramRunnable[numRunnables]; + for (int i = 0; i < numRunnables; i++) { + runnables[i] = new UpdateHistogramRunnable(histogram, i); + executor.execute(runnables[i]); + } + + try { + executor.shutdown(); + executor.awaitTermination(30, TimeUnit.SECONDS); Review Comment: right now it is executing the tasks 1 by 1 not (possibly) concurrently since execute is being called in the loop Consider using https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CountDownLatch.html you can do something like the following to make the test more deterministic (not bound bu `CountDownLatch testLatch = new CountDownLatch(howManyTimesYouWantTheRunnableToRun)` pass `testLatch` into `UpdateHistogramRunnable` constructor at the end of `UpdateHistogramRunnable#run()` method call `testsLatch.countDown()` then call `testLatch.await()` (wait until this has ran `howManyTimesYouWantTheRunnableToRun`) and then use ExecutorService#submit to submit each runnable, this does not block until the runnable is done another way is to not call execute in the `loop`, build the list of `UpdateHistogramRunnable` then use `ExecutorService.invokeAll(UpdateHistogramRunnable)`. I think right now it is executing 1 by 1. based on lang specification invokeAll blocks but i haven't used it -- 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]
