net.logstash.logback.argument.DeferredStructuredArgument Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013-2023 the original author or authors.
 *
 * Licensed 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 net.logstash.logback.argument;

import java.io.IOException;
import java.util.Objects;
import java.util.function.Supplier;

import net.logstash.logback.marker.EmptyLogstashMarker;

import ch.qos.logback.classic.spi.LoggingEvent;
import com.fasterxml.jackson.core.JsonGenerator;
import org.slf4j.Logger;

/**
 * A {@link StructuredArgument} that defers the creation of another {@link StructuredArgument} until
 * the first time its value is needed.
 *
 * The value is needed in the following conditions:
 * 
 *     When {@link LoggingEvent#getFormattedMessage()} is called
 *     When {@link LoggingEvent#prepareForDeferredProcessing()} ()} is called
 *         (async appenders call this prior to dispatching the event to another thread)
 *     When the {@link LoggingEvent} is encoded
 * 
 *
 * The deferred value will always be created in the thread calling the {@link Logger}
 * (even if an async appender is used) since the values of structured arguments are needed
 * when {@link LoggingEvent#prepareForDeferredProcessing()} is called
 * (by async appenders prior to dispatching the event to another thread).
 *
 * 
The deferred value will only be calculated once.
 * The single value supplied by the supplier will be reused every time the structured argument is written.
 * For example, if multiple appenders use a logstash encoder,
 * the supplier will be invoked when the first appender encodes the marker.
 * That same supplied value will be used when the next appender encodes the marker.
 */
public class DeferredStructuredArgument implements StructuredArgument {

    /**
     * Supplier for the deferred {@link StructuredArgument}
     */
    private final Supplier structureArgumentSupplier;

    /**
     * Cached value of the structured argument returned by {@link #structureArgumentSupplier}.
     * {@code null} until {@link #getSuppliedValue()} is first called.
     */
    private volatile StructuredArgument suppliedValue;

    public DeferredStructuredArgument(Supplier structureArgumentSupplier) {
        this.structureArgumentSupplier = Objects.requireNonNull(structureArgumentSupplier, "structureArgumentSupplier must not be null");
    }

    @Override
    public void writeTo(JsonGenerator generator) throws IOException {
        getSuppliedValue().writeTo(generator);
    }

    /**
     * Get the deferred structure argument from the supplier or return it from the cache
     * if already initialized.
     * 
     * @return the deferred structured argument
     */
    private StructuredArgument getSuppliedValue() {
        if (suppliedValue == null) {
            synchronized (this) {
                if (suppliedValue == null) {
                    StructuredArgument structuredArgument = structureArgumentSupplier.get();
                    if (structuredArgument == null) {
                        structuredArgument = new EmptyLogstashMarker();
                    }
                    suppliedValue = structuredArgument;
                }
            }
        }
        return suppliedValue;
    }

}