StructuredDataLookup

java.lang.Object

org.apache.logging.log4j.core.lookup.AbstractLookup

org.apache.logging.log4j.core.lookup.StructuredDataLookup

All Implemented Interfaces:: StrLookup

@Plugin(name="sd", category="Lookup") public class StructuredDataLookup extends AbstractLookup

Looks up keys from StructuredDataMessage log messages.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

ID_KEY

Key to obtain the id of a structured message.

static final String

TYPE_KEY

Key to obtain the type of a structured message.

Fields inherited from interface StrLookup
CATEGORY
Constructor Summary

Constructors

Constructor

Description

StructuredDataLookup()
Method Summary

Modifier and Type

Method

Description

String

lookup(LogEvent event, String key)

Looks up the value for the key using the data in the LogEvent.

Methods inherited from class AbstractLookup
evaluate, lookup

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface StrLookup
evaluate

Field Details
- ID_KEY
  public static final String ID_KEY
  
  Key to obtain the id of a structured message.
  
  See Also:
  
  Constant Field Values
- TYPE_KEY
  public static final String TYPE_KEY
  
  Key to obtain the type of a structured message.
  
  See Also:
  
  Constant Field Values
Constructor Details
- StructuredDataLookup
  
  public StructuredDataLookup()
Method Details
- lookup
  
  public String lookup(LogEvent event, String key)
  
  Looks up the value for the key using the data in the LogEvent.
  
  Parameters:
  
  event - The current LogEvent.
  
  key - The key to be looked up, may be null.
  
  Returns:
  
  The value associated with the key.