/*
 * 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.core.lookup;

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.message.StructuredDataMessage;

Looks up keys from StructuredDataMessage log messages.
/** * Looks up keys from {@link org.apache.logging.log4j.message.StructuredDataMessage} log messages. */
@Plugin(name = "sd", category = StrLookup.CATEGORY) public class StructuredDataLookup implements StrLookup {
Returns null. This Lookup plugin does not make sense outside the context of a LogEvent.
Params:
  • key – the key to be looked up, may be null
Returns:null
/** * Returns {@code null}. This Lookup plugin does not make sense outside the context of a LogEvent. * @param key the key to be looked up, may be null * @return {@code null} */
@Override public String lookup(final String key) { return null; }
Looks up the value for the key using the data in the LogEvent.
Params:
  • event – The current LogEvent.
  • key – the key to be looked up, may be null
Returns:The value associated with the key.
/** * Looks up the value for the key using the data in the LogEvent. * @param event The current LogEvent. * @param key the key to be looked up, may be null * @return The value associated with the key. */
@Override public String lookup(final LogEvent event, final String key) { if (event == null || !(event.getMessage() instanceof StructuredDataMessage)) { return null; } final StructuredDataMessage msg = (StructuredDataMessage) event.getMessage(); if (key.equalsIgnoreCase("id")) { return msg.getId().getName(); } else if (key.equalsIgnoreCase("type")) { return msg.getType(); } return msg.get(key); } }