org.apache.logging.log4j.layout.template.json.resolver.LoggerResolver Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of log4j-layout-template-json Show documentation

Apache Log4j Layout for JSON template.

There is a newer version: 3.0.0-beta2

Show newest version

/*
 * 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.template.json.resolver;

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.layout.template.json.util.JsonWriter;

/**
 * Logger resolver.
 *
 * Configuration
 *
 *  * config = "field" -> ( "name" | "fqcn" )
 * 
 *
 * Examples
 *
 * Resolve the logger name:
 *
 *  * {
 *   "$resolver": "logger",
 *   "field": "name"
 * }
 * 
 *
 * Resolve the logger's fully qualified class name:
 *
 *  * {
 *   "$resolver": "logger",
 *   "field": "fqcn"
 * }
 * 
 */
public final class LoggerResolver implements EventResolver {

    private static final EventResolver NAME_RESOLVER =
            (final LogEvent logEvent, final JsonWriter jsonWriter) -> {
                final String loggerName = logEvent.getLoggerName();
                jsonWriter.writeString(loggerName);
            };

    private static final EventResolver FQCN_RESOLVER =
            (final LogEvent logEvent, final JsonWriter jsonWriter) -> {
                final String loggerFqcn = logEvent.getLoggerFqcn();
                jsonWriter.writeString(loggerFqcn);
            };

    private final EventResolver internalResolver;

    LoggerResolver(final TemplateResolverConfig config) {
        this.internalResolver = createInternalResolver(config);
    }

    private static EventResolver createInternalResolver(
            final TemplateResolverConfig config) {
        final String fieldName = config.getString("field");
        if ("name".equals(fieldName)) {
            return NAME_RESOLVER;
        } else if ("fqcn".equals(fieldName)) {
            return FQCN_RESOLVER;
        }
        throw new IllegalArgumentException("unknown field: " + config);
    }

    static String getName() {
        return "logger";
    }

    @Override
    public void resolve(
            final LogEvent logEvent,
            final JsonWriter jsonWriter) {
        internalResolver.resolve(logEvent, jsonWriter);
    }

}