io.quarkiverse.loggingjson.providers.StructuredArgument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkiverse-logging-json Show documentation

Logging in json with support for custom fields

There is a newer version: 0.2.3

Show newest version

package io.quarkiverse.loggingjson.providers;

import java.io.IOException;

import org.slf4j.Logger;

import io.quarkiverse.loggingjson.JsonGenerator;

/**
 * A wrapper for an argument passed to a log method (e.g. {@link Logger#info(String, Object...)})
 * that adds data to the JSON event (via {@link ArgumentsJsonProvider}).
 */
public interface StructuredArgument {

    /**
     * Writes the data associated with this argument to the given {@link JsonGenerator}.
     */
    void writeTo(JsonGenerator generator) throws IOException;

    /**
     * Writes the data associated with this argument to a {@link String} to be
     * included in a log event's formatted message (via parameter substitution).
     * 
     * Note that this will only be included in the log event's formatted
     * message if the message format includes a parameter for this argument.
     */
    String toString();

}