log4j-perf/src/main/java/org/apache/logging/log4j/layout/json/template/JsonTemplateLayoutBenchmark.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.logging.log4j.layout.json.template;

import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.layout.ByteBufferDestination;
import org.openjdk.jmh.annotations.Benchmark;

import java.nio.ByteBuffer;
import java.util.List;

/**
 * Benchmark suite for various JSON layouts.
 * <p>
 * You can run this test as follows:
 * <pre>
 * java \
 *     -jar log4j-perf/target/benchmarks.jar \
 *     -f 2 \
 *     -wi 3 -w 20s \
 *     -i 5 -r 30s \
 *     -prof gc \
 *     -rf json -rff log4j-perf/target/JsonTemplateLayoutBenchmarkResult.json \
 *     ".*JsonTemplateLayoutBenchmark.*"
 * </pre>
 */
public class JsonTemplateLayoutBenchmark {

    @Benchmark
    public static int fullJsonTemplateLayout4JsonLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getJsonTemplateLayout4JsonLayout(),
                state.getFullLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int liteJsonTemplateLayout4JsonLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getJsonTemplateLayout4JsonLayout(),
                state.getLiteLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int fullJsonTemplateLayout4EcsLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getJsonTemplateLayout4EcsLayout(),
                state.getFullLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int liteJsonTemplateLayout4EcsLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getJsonTemplateLayout4EcsLayout(),
                state.getLiteLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int fullJsonTemplateLayout4GelfLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getJsonTemplateLayout4GelfLayout(),
                state.getFullLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int liteJsonTemplateLayout4GelfLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getJsonTemplateLayout4GelfLayout(),
                state.getLiteLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int fullDefaultJsonLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getDefaultJsonLayout(),
                state.getFullLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int liteDefaultJsonLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getDefaultJsonLayout(),
                state.getLiteLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int fullCustomJsonLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getCustomJsonLayout(),
                state.getFullLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int liteCustomJsonLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getCustomJsonLayout(),
                state.getLiteLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int fullEcsLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getEcsLayout(),
                state.getFullLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int liteEcsLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getEcsLayout(),
                state.getLiteLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int fullGelfLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getGelfLayout(),
                state.getFullLogEvents(),
                state.getByteBufferDestination());
    }

    @Benchmark
    public static int liteGelfLayout(
            final JsonTemplateLayoutBenchmarkState state) {
        return benchmark(
                state.getGelfLayout(),
                state.getLiteLogEvents(),
                state.getByteBufferDestination());
    }

    private static int benchmark(
            final Layout<String> layout,
            final List<LogEvent> logEvents,
            final ByteBufferDestination destination) {
        // noinspection ForLoopReplaceableByForEach (avoid iterator instantiation)
        for (int logEventIndex = 0; logEventIndex < logEvents.size(); logEventIndex++) {
            LogEvent logEvent = logEvents.get(logEventIndex);
            layout.encode(logEvent, destination);
        }
        final ByteBuffer byteBuffer = destination.getByteBuffer();
        final int position = byteBuffer.position();
        byteBuffer.clear();
        return position;
    }

}