Package org.springframework.boot.logging.logback

Class CorrelationIdConverter

java.lang.Object
ch.qos.logback.core.pattern.Converter<E>
ch.qos.logback.core.pattern.FormattingConverter<E>
ch.qos.logback.core.pattern.DynamicConverter<ch.qos.logback.classic.spi.ILoggingEvent>
org.springframework.boot.logging.logback.CorrelationIdConverter
All Implemented Interfaces:
ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle
public class CorrelationIdConverter extends ch.qos.logback.core.pattern.DynamicConverter<ch.qos.logback.classic.spi.ILoggingEvent>
Logback DynamicConverter to convert a CorrelationIdFormatter pattern into formatted output using data from the MDC and Environment.
Since:
3.2.0
Author:
Phillip Webb
See Also:
  • MDCConverter

  • Field Summary

    Fields inherited from class ch.qos.logback.core.pattern.DynamicConverter

    started

  • Constructor Summary

    Constructors
    Constructor
    Description
    CorrelationIdConverter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    convert(ch.qos.logback.classic.spi.ILoggingEvent event)
     
    void
    start()
     
    void
    stop()
     

    Methods inherited from class ch.qos.logback.core.pattern.DynamicConverter

    addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getFirstOption, getOptionList, isStarted, setContext, setOptionList

    Methods inherited from class ch.qos.logback.core.pattern.FormattingConverter

    getFormattingInfo, setFormattingInfo, write

    Methods inherited from class ch.qos.logback.core.pattern.Converter

    getNext, setNext

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CorrelationIdConverter

      public CorrelationIdConverter()

  • Method Details

    • start

      public void start()
      Specified by:
      start in interface ch.qos.logback.core.spi.LifeCycle
      Overrides:
      start in class ch.qos.logback.core.pattern.DynamicConverter<ch.qos.logback.classic.spi.ILoggingEvent>

    • stop

      public void stop()
      Specified by:
      stop in interface ch.qos.logback.core.spi.LifeCycle
      Overrides:
      stop in class ch.qos.logback.core.pattern.DynamicConverter<ch.qos.logback.classic.spi.ILoggingEvent>

    • convert

      public String convert(ch.qos.logback.classic.spi.ILoggingEvent event)
      Specified by:
      convert in class ch.qos.logback.core.pattern.Converter<ch.qos.logback.classic.spi.ILoggingEvent>