kennknowles commented on a change in pull request #10949: [BEAM-9371] Add SideInputLoadTest to Java SDK URL: https://github.com/apache/beam/pull/10949#discussion_r386745742
########## File path: sdks/java/testing/load-tests/src/main/java/org/apache/beam/sdk/loadtests/SideInputLoadTest.java ########## @@ -0,0 +1,243 @@ +/* + * 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.sdk.loadtests; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Random; +import org.apache.beam.sdk.io.synthetic.SyntheticStep; +import org.apache.beam.sdk.options.Default; +import org.apache.beam.sdk.options.Description; +import org.apache.beam.sdk.options.Validation; +import org.apache.beam.sdk.testutils.metrics.ByteMonitor; +import org.apache.beam.sdk.transforms.DoFn; +import org.apache.beam.sdk.transforms.ParDo; +import org.apache.beam.sdk.transforms.View; +import org.apache.beam.sdk.transforms.windowing.FixedWindows; +import org.apache.beam.sdk.transforms.windowing.Window; +import org.apache.beam.sdk.values.KV; +import org.apache.beam.sdk.values.PCollection; +import org.apache.beam.sdk.values.PCollectionView; +import org.joda.time.Duration; +import org.joda.time.Instant; + +/** + * Load test for operations involving side inputs. + * + * <p>The purpose of this test is to measure cost of materialization or lookup of side inputs. It + * uses synthetic sources and {@link SyntheticStep} which can be parametrized to generate records + * with various sizes of keys and values, impose delays in the pipeline and simulate other + * performance challenges. + * + * <p>To run the test manually, use the following command: + * + * <pre> + * ./gradlew :sdks:java:testing:load-tests:run -PloadTest.args=' + * --sourceOptions={"numRecords":2000, ...} + * --sideInputType=ITERABLE + * --accessPercentage=1 + * --windowCount=200 + * </pre> + */ +public class SideInputLoadTest extends LoadTest<SideInputLoadTest.Options> { + + private static final String METRICS_NAMESPACE = "sideinput"; + private static final Instant TIME = new Instant(); + + public SideInputLoadTest(String[] args) throws IOException { + super(args, Options.class, METRICS_NAMESPACE); + } + + @Override + void loadTest() throws IOException { + Optional<SyntheticStep> syntheticStep = createStep(options.getStepOptions()); + PCollection<KV<byte[], byte[]>> input = + pipeline + .apply(readFromSource(sourceOptions)) + .apply(ParDo.of(new AddTimestamps())) + .apply("Collect start time metrics", ParDo.of(runtimeMonitor)) + .apply(ParDo.of(new ByteMonitor(METRICS_NAMESPACE, "totalBytes.count"))); + + performTestWithSideInput( + input, SideInputMaterializationType.valueOf(options.getSideInputType()), syntheticStep); + } + + private void performTestWithSideInput( + PCollection<KV<byte[], byte[]>> input, + SideInputMaterializationType sideInputType, + Optional<SyntheticStep> syntheticStep) { + switch (sideInputType) { + case ITERABLE: + performTestWithIterable(input, syntheticStep); + break; + case HASHMAP: + performTestWithHashMap(input, syntheticStep); + break; + case LIST: + performTestWithList(input, syntheticStep); + break; + } + } + + private void performTestWithList( + PCollection<KV<byte[], byte[]>> input, Optional<SyntheticStep> syntheticStep) { + applyStepIfPresent(input, "Synthetic step", syntheticStep); + PCollectionView<List<KV<byte[], byte[]>>> sideInput = input.apply(View.asList()); + input + .apply(ParDo.of(new SideInputTestWithList(sideInput)).withSideInputs(sideInput)) + .apply("Collect end time metrics", ParDo.of(runtimeMonitor)); + } + + private void performTestWithHashMap( + PCollection<KV<byte[], byte[]>> input, Optional<SyntheticStep> syntheticStep) { + applyStepIfPresent(input, "Synthetic step", syntheticStep); + PCollectionView<Map<byte[], byte[]>> sideInput = input.apply(View.asMap()); + input + .apply(ParDo.of(new SideInputTestWithHashMap(sideInput)).withSideInputs(sideInput)) + .apply("Collect end time metrics", ParDo.of(runtimeMonitor)); + } + + private void performTestWithIterable( + PCollection<KV<byte[], byte[]>> input, Optional<SyntheticStep> syntheticStep) { + applyStepIfPresent(input, "Synthetic step", syntheticStep); + PCollectionView<Iterable<KV<byte[], byte[]>>> sideInput; + if (options.getWindowCount() != 0) { + long windowDurationMilis = sourceOptions.numRecords / options.getWindowCount(); + sideInput = + input + .apply(Window.into(FixedWindows.of(Duration.millis(windowDurationMilis)))) + .apply(View.asIterable()); + } else { + sideInput = input.apply(View.asIterable()); + } + + input + .apply(ParDo.of(new SideInputTestWithIterable(sideInput)).withSideInputs(sideInput)) + .apply("Collect end time metrics", ParDo.of(runtimeMonitor)); + } + + private static class AddTimestamps extends DoFn<KV<byte[], byte[]>, KV<byte[], byte[]>> { + private static Instant timestamp = TIME; + + @ProcessElement + public void processElement(ProcessContext c) { + timestamp = TIME.plus(1L); + c.outputWithTimestamp(c.element(), timestamp); + } + } + + private static class SideInputTestWithList extends DoFn<KV<byte[], byte[]>, KV<byte[], byte[]>> { + + private final PCollectionView<List<KV<byte[], byte[]>>> sideInput; + + public SideInputTestWithList(PCollectionView<List<KV<byte[], byte[]>>> sideInput) { + this.sideInput = sideInput; + } + + @ProcessElement + public void processElement(ProcessContext c) { + List<KV<byte[], byte[]>> si = c.sideInput(sideInput); + + for (KV<byte[], byte[]> sideInputElement : si) { + // for every _input_ element iterate over all _sideInput_ elements + // count consumed bytes, examine memory usage, etc (Metrics API). + byte[] key = sideInputElement.getKey(); + } + } + } + + private class SideInputTestWithHashMap extends DoFn<KV<byte[], byte[]>, KV<byte[], byte[]>> { + + private final PCollectionView<Map<byte[], byte[]>> sideInput; + + public SideInputTestWithHashMap(PCollectionView<Map<byte[], byte[]>> sideInput) { + this.sideInput = sideInput; + } + + @ProcessElement + public void processElement(ProcessContext c) { + Map<byte[], byte[]> si = c.sideInput(sideInput); + // access Map elements according to options - % of random access + ArrayList<byte[]> keyList = new ArrayList<>(si.keySet()); Review comment: This part doesn't work well at high scale for some map implementations. An important use case is accessing just some keys and not others. A runner/SDK may have a separate place where they write the keySet so that you can make this call efficiently. But they may not. We don't want to make this test so sensitive to that (you could separate test efficiency of keySet). Can you calculate random keys in advance based on `sourceOptions`? ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
