Package org.elasticsearch.common.logging

Class TraceIdConverter

java.lang.Object
org.apache.logging.log4j.core.pattern.AbstractPatternConverter
org.apache.logging.log4j.core.pattern.LogEventPatternConverter
org.elasticsearch.common.logging.TraceIdConverter
All Implemented Interfaces:
org.apache.logging.log4j.core.pattern.PatternConverter
@Plugin(category="Converter", name="TraceIdConverter") public final class TraceIdConverter extends org.apache.logging.log4j.core.pattern.LogEventPatternConverter
Pattern converter to format the trace id provided in the traceparent header into JSON fields trace.id.

  • Field Summary

    Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

    LOGGER

    Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

    CATEGORY

  • Constructor Summary

    Constructors
    Constructor
    Description
    TraceIdConverter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    format​(org.apache.logging.log4j.core.LogEvent event, StringBuilder toAppendTo)
    Formats the trace.id into json fields.
    static String
    getTraceId()
     
    static TraceIdConverter
    newInstance​(String[] options)
    Called by log4j2 to initialize this converter.

    Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

    format, handlesThrowable, isVariable

    Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

    getName, getStyleClass

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • TraceIdConverter

      public TraceIdConverter()

  • Method Details

    • newInstance

      public static TraceIdConverter newInstance​(String[] options)
      Called by log4j2 to initialize this converter.

    • getTraceId

      public static String getTraceId()

    • format

      public void format​(org.apache.logging.log4j.core.LogEvent event, StringBuilder toAppendTo)
      Formats the trace.id into json fields.
      Specified by:
      format in class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
      Parameters:
      event - - a log event is ignored in this method as it uses the clusterId value from NodeAndClusterIdStateListener to format