SedaDisruptorCompareTest.java

/**
 * 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.camel.component.disruptor;


import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

import com.lmax.disruptor.collections.Histogram;

import org.apache.camel.Endpoint;
import org.apache.camel.Exchange;
import org.apache.camel.ExchangePattern;
import org.apache.camel.Processor;
import org.apache.camel.Produce;
import org.apache.camel.ProducerTemplate;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.component.seda.SedaEndpoint;
import org.apache.camel.test.junit4.CamelTestSupport;
import org.junit.BeforeClass;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;

/**
 * This class does not perform any functional test, but instead makes a comparison between the performance of the
 * Disruptor and SEDA component in several use cases.
 * <p/>
 * As memory management may have great impact on the results, it is adviced to run this test with a large, fixed heap (e.g. run with -Xmx1024m -Xms1024m JVM parameters)
 */
@Ignore
@RunWith(value = Parameterized.class)
public class SedaDisruptorCompareTest extends CamelTestSupport {
    // Use '0' for default value, '1'+ for specific value to be used by both SEDA and DISRUPTOR.
    private static final int SIZE_PARAMETER_VALUE = 1024;
    private static final int SPEED_TEST_EXCHANGE_COUNT = 80000;
    private static final long[] LATENCY_HISTOGRAM_BOUNDS = new long[] {1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, 2000, 5000};
    private static final long[] DISRUPTOR_SIZE_HISTOGRAM_BOUNDS = generateLinearHistogramBounds(
            SIZE_PARAMETER_VALUE == 0 ? 1024 : SIZE_PARAMETER_VALUE, 8);
    private static final long[] SEDA_SIZE_HISTOGRAM_BOUNDS = generateLinearHistogramBounds(
            SIZE_PARAMETER_VALUE == 0 ? SPEED_TEST_EXCHANGE_COUNT : SIZE_PARAMETER_VALUE, 10);

    @Produce
    protected ProducerTemplate producerTemplate;

    private final ExchangeAwaiter[] exchangeAwaiters;
    private final String componentName;
    private final String endpointUri;
    private final int amountProducers;
    private final long[] sizeHistogramBounds;

    private final Queue<Integer> endpointSizeQueue = new ConcurrentLinkedQueue<Integer>();
    
    public SedaDisruptorCompareTest(final String componentName, final String endpointUri,
                                    final int amountProducers, final int amountConsumers,
                                    final int concurrentConsumerThreads, final long[] sizeHistogramBounds) {
        this.componentName = componentName;
        this.endpointUri = endpointUri;
        this.amountProducers = amountProducers;
        this.sizeHistogramBounds = sizeHistogramBounds;
        exchangeAwaiters = new ExchangeAwaiter[amountConsumers];
        for (int i = 0; i < amountConsumers; ++i) {
            exchangeAwaiters[i] = new ExchangeAwaiter(SPEED_TEST_EXCHANGE_COUNT);
        }
    }

    @BeforeClass
    public static void legend() {
        System.out.println("-----------------------");
        System.out.println("- Tests output legend -");
        System.out.println("-----------------------");
        System.out.println(
                "P: Number of concurrent Producer(s) sharing the load for publishing exchanges to the disruptor.");
        System.out.println(
                "C: Number of Consumer(s) receiving a copy of each exchange from the disruptor (pub/sub).");
        System.out.println(
                "CCT: Number of ConcurrentConsumerThreads sharing the load for consuming exchanges from the disruptor.");
        System.out.println(
                "SIZE: Maximum number of elements a SEDA or disruptor endpoint can have in memory before blocking the Producer thread(s).");
        System.out.println("      0 means default value, so unbounded for SEDA and 1024 for disruptor.");
        System.out.println("Each test is creating " + SPEED_TEST_EXCHANGE_COUNT + " exchanges.");
        System.out.println();
    }

    private static long[] generateLinearHistogramBounds(final int maxValue, final int nbSlots) {
        final long slotSize = maxValue / nbSlots;
        final long[] bounds = new long[nbSlots];
        for (int i = 0; i < nbSlots; i++) {
            bounds[i] = slotSize * (i + 1);
        }
        return bounds;
    }

    

    private static int singleProducer() {
        return 1;
    }

    private static int multipleProducers() {
        return 4;
    }

    private static int singleConsumer() {
        return 1;
    }

    private static int multipleConsumers() {
        return 4;
    }

    private static int singleConcurrentConsumerThread() {
        return 1;
    }

    private static int multipleConcurrentConsumerThreads() {
        return 2;
    }

    @Parameterized.Parameters(name = "{index}: {0}")
    public static Collection<Object[]> parameters() {
        final List<Object[]> parameters = new ArrayList<Object[]>();

        // This parameter set can be compared to the next and shows the impact of a 'long' endpoint name
        // It defines all parameters to the same values as the default, so the result should be the same as
        // 'seda:speedtest'. This shows that disruptor has a slight disadvantage as its name is longer than 'seda' :)
        // The reason why this test takes so long is because Camel has a SLF4J call in ProducerCache:
        // LOG.debug(">>>> {} {}", endpoint, exchange);
        // and the DefaultEndpoint.toString() method will use a Matcher to sanitize the URI.  There should be a guard
        // before the debug() call to only evaluate the args when required: if(LOG.isDebugEnabled())...
        if (SIZE_PARAMETER_VALUE == 0) {
            parameters
                .add(new Object[] {"SEDA LONG {P=1, C=1, CCT=1, SIZE=0}",
                    "seda:speedtest?concurrentConsumers=1&waitForTaskToComplete=IfReplyExpected&timeout=30000&multipleConsumers=false&limitConcurrentConsumers=true&blockWhenFull=false",
                    singleProducer(), singleConsumer(), singleConcurrentConsumerThread(),
                    SEDA_SIZE_HISTOGRAM_BOUNDS});
        } else {
            parameters
                .add(new Object[] {"SEDA LONG {P=1, C=1, CCT=1, SIZE=" + SIZE_PARAMETER_VALUE + "}",
                    "seda:speedtest?concurrentConsumers=1&waitForTaskToComplete=IfReplyExpected&timeout=30000&multipleConsumers=false&limitConcurrentConsumers=true&blockWhenFull=true&size="
                        + SIZE_PARAMETER_VALUE,
                    singleProducer(), singleConsumer(),
                    singleConcurrentConsumerThread(), SEDA_SIZE_HISTOGRAM_BOUNDS});
        }
        addParameterPair(parameters, singleProducer(), singleConsumer(), singleConcurrentConsumerThread());
        addParameterPair(parameters, singleProducer(), singleConsumer(), multipleConcurrentConsumerThreads());
        addParameterPair(parameters, singleProducer(), multipleConsumers(), singleConcurrentConsumerThread());
        addParameterPair(parameters, singleProducer(), multipleConsumers(),
                multipleConcurrentConsumerThreads());
        addParameterPair(parameters, multipleProducers(), singleConsumer(), singleConcurrentConsumerThread());
        addParameterPair(parameters, multipleProducers(), singleConsumer(),
                multipleConcurrentConsumerThreads());
        addParameterPair(parameters, multipleProducers(), multipleConsumers(),
                singleConcurrentConsumerThread());
        addParameterPair(parameters, multipleProducers(), multipleConsumers(),
                multipleConcurrentConsumerThreads());

        return parameters;
    }

    private static void addParameterPair(final List<Object[]> parameters, final int producers,
                                         final int consumers, final int parallelConsumerThreads) {
        final String multipleConsumerOption = consumers > 1 ? "multipleConsumers=true" : "";
        final String concurrentConsumerOptions = parallelConsumerThreads > 1 ? "concurrentConsumers=" + parallelConsumerThreads : "";
        final String sizeOption = SIZE_PARAMETER_VALUE > 0 ? "size=" + SIZE_PARAMETER_VALUE : "";
        final String sizeOptionSeda = SIZE_PARAMETER_VALUE > 0 ? "&blockWhenFull=true" : "";

        String options = "";
        if (!multipleConsumerOption.isEmpty()) {
            if (!options.isEmpty()) {
                options += "&";
            }
            options += multipleConsumerOption;
        }
        if (!concurrentConsumerOptions.isEmpty()) {
            if (!options.isEmpty()) {
                options += "&";
            }
            options += concurrentConsumerOptions;
        }
        if (!sizeOption.isEmpty()) {
            if (!options.isEmpty()) {
                options += "&";
            }
            options += sizeOption;
        }

        if (!options.isEmpty()) {
            options = "?" + options;
        }

        final String sedaOptions = sizeOptionSeda.isEmpty() ? options : options + sizeOptionSeda;
        // Using { ... } because there is a bug in JUnit 4.11 and Eclipse: https://bugs.eclipse.org/bugs/show_bug.cgi?id=102512
        final String testDescription = " { P=" + producers + ", C=" + consumers + ", CCT="
                + parallelConsumerThreads + ", SIZE=" + SIZE_PARAMETER_VALUE + " }";
        parameters.add(new Object[] {"SEDA" + testDescription, "seda:speedtest" + sedaOptions, producers,
            consumers, parallelConsumerThreads, SEDA_SIZE_HISTOGRAM_BOUNDS});
        parameters.add(new Object[] {"Disruptor" + testDescription, "disruptor:speedtest" + options, producers,
            consumers, parallelConsumerThreads, DISRUPTOR_SIZE_HISTOGRAM_BOUNDS});
    }

    @Test
    public void speedTestDisruptor() throws InterruptedException {

        System.out.println("Warming up for test of: " + componentName);

        performTest(true);
        System.out.println("Starting real test of: " + componentName);

        forceGC();
        Thread.sleep(1000);

        performTest(false);
    }

    private void forceGC() {
        // unfortunately there is no nice API that forces the Garbage collector to run, but it may consider our request
        // more seriously if we ask it twice :)
        System.gc();
        System.gc();
    }

    private void resetExchangeAwaiters() {
        for (final ExchangeAwaiter exchangeAwaiter : exchangeAwaiters) {
            exchangeAwaiter.reset();
        }
    }

    private void awaitExchangeAwaiters() throws InterruptedException {
        for (final ExchangeAwaiter exchangeAwaiter : exchangeAwaiters) {
            while (!exchangeAwaiter.awaitMessagesReceived(10, TimeUnit.SECONDS)) {
                System.err.println(
                        "Processing takes longer then expected: " + componentName + " " + exchangeAwaiter
                                .getStatus());
            }
        }
    }

    private void outputExchangeAwaitersResult(final long start) throws InterruptedException {
        for (final ExchangeAwaiter exchangeAwaiter : exchangeAwaiters) {
            final long stop = exchangeAwaiter.getCountDownReachedTime();
            final Histogram histogram = exchangeAwaiter.getLatencyHistogram();

            System.out.printf("%-45s time spent = %5d ms. Latency (ms): %s %n", componentName, stop - start, histogram.toString());
        }
    }

    private void performTest(final boolean warmup) throws InterruptedException {
        resetExchangeAwaiters();

        final ProducerThread[] producerThread = new ProducerThread[amountProducers];
        for (int i = 0; i < producerThread.length; ++i) {
            producerThread[i] = new ProducerThread(SPEED_TEST_EXCHANGE_COUNT / amountProducers);
        }

        ExecutorService monitoring = null;
        if (!warmup) {
            monitoring = installSizeMonitoring(context.getEndpoint(endpointUri));
        }
        final long start = System.currentTimeMillis();

        for (ProducerThread element : producerThread) {
            element.start();
        }

        awaitExchangeAwaiters();

        if (!warmup) {
            outputExchangeAwaitersResult(start);
            uninstallSizeMonitoring(monitoring);
        }
    }

    private ExecutorService installSizeMonitoring(final Endpoint endpoint) {
        final ScheduledExecutorService service = context.getExecutorServiceManager()
                .newScheduledThreadPool(this, "SizeMonitoringThread", 1);
        endpointSizeQueue.clear();
        final Runnable monitoring = new Runnable() {
            @Override
            public void run() {
                if (endpoint instanceof SedaEndpoint) {
                    final SedaEndpoint sedaEndpoint = (SedaEndpoint)endpoint;
                    endpointSizeQueue.offer(sedaEndpoint.getCurrentQueueSize());
                } else if (endpoint instanceof DisruptorEndpoint) {
                    final DisruptorEndpoint disruptorEndpoint = (DisruptorEndpoint)endpoint;

                    long remainingCapacity = 0;
                    try {
                        remainingCapacity = disruptorEndpoint.getRemainingCapacity();
                    } catch (DisruptorNotStartedException e) {
                        //ignore
                    }
                    endpointSizeQueue.offer((int)(disruptorEndpoint.getBufferSize() - remainingCapacity));
                }
            }
        };
        service.scheduleAtFixedRate(monitoring, 0, 100, TimeUnit.MILLISECONDS);
        return service;
    }

    private void uninstallSizeMonitoring(final ExecutorService monitoring) {
        if (monitoring != null) {
            monitoring.shutdownNow();
        }
        final Histogram histogram = new Histogram(sizeHistogramBounds);
        for (final int observation : endpointSizeQueue) {
            histogram.addObservation(observation);
        }
        System.out.printf("%82s %s%n", "Endpoint size (# exchanges pending):", histogram.toString());
    }

    @Override
    protected RouteBuilder createRouteBuilder() throws Exception {
        return new RouteBuilder() {
            @Override
            public void configure() throws Exception {
                for (final ExchangeAwaiter exchangeAwaiter : exchangeAwaiters) {
                    from(endpointUri).process(exchangeAwaiter);
                }
            }
        };
    }

    private static final class ExchangeAwaiter implements Processor {

        private CountDownLatch latch;
        private final int count;
        private long countDownReachedTime;

        private Queue<Long> latencyQueue = new ConcurrentLinkedQueue<Long>();

        ExchangeAwaiter(final int count) {
            this.count = count;
        }

        public void reset() {
            latencyQueue = new ConcurrentLinkedQueue<Long>();
            latch = new CountDownLatch(count);
            countDownReachedTime = 0;
        }

        public boolean awaitMessagesReceived(final long timeout, final TimeUnit unit) throws InterruptedException {
            return latch.await(timeout, unit);
        }

        public String getStatus() {
            final StringBuilder sb = new StringBuilder(100);
            sb.append("processed ");
            sb.append(count - latch.getCount());
            sb.append('/');
            sb.append(count);
            sb.append(" messages");

            return sb.toString();
        }

        @Override
        public void process(final Exchange exchange) throws Exception {
            final long sentTimeNs = exchange.getIn().getBody(Long.class);
            latencyQueue.offer(Long.valueOf(System.nanoTime() - sentTimeNs));

            countDownReachedTime = System.currentTimeMillis();
            latch.countDown();
        }

        public long getCountDownReachedTime() {
            // Make sure we wait until all exchanges have been processed. Otherwise the time value doesn't make sense.
            try {
                latch.await();
            } catch (InterruptedException e) {
                countDownReachedTime = 0;
            }
            return countDownReachedTime;
        }

        public Histogram getLatencyHistogram() {
            final Histogram histogram = new Histogram(LATENCY_HISTOGRAM_BOUNDS);
            for (final Long latencyValue : latencyQueue) {
                histogram.addObservation(latencyValue / 1000000);
            }
            return histogram;
        }
    }

    private final class ProducerThread extends Thread {

        private final int totalMessageCount;
        private int producedMessageCount;

        ProducerThread(final int totalMessageCount) {
            super("TestDataProducerThread");
            this.totalMessageCount = totalMessageCount;
        }

        public void run() {
            final Endpoint endpoint = context().getEndpoint(endpointUri);
            while (producedMessageCount++ < totalMessageCount) {
                producerTemplate.sendBody(endpoint, ExchangePattern.InOnly, System.nanoTime());
            }
        }
    }
}