Class OpenTelemetryAppender

java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
io.opentelemetry.instrumentation.log4j.appender.v2_17.OpenTelemetryAppender
All Implemented Interfaces:
org.apache.logging.log4j.core.Appender, org.apache.logging.log4j.core.filter.Filterable, org.apache.logging.log4j.core.impl.LocationAware, org.apache.logging.log4j.core.LifeCycle, org.apache.logging.log4j.core.LifeCycle2

@Plugin(name="OpenTelemetry", category="Core", elementType="appender") public class OpenTelemetryAppender extends org.apache.logging.log4j.core.appender.AbstractAppender
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
     

    Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

    org.apache.logging.log4j.core.LifeCycle.State
  • Field Summary

    Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

    DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

    Fields inherited from interface org.apache.logging.log4j.core.Appender

    ELEMENT_TYPE
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append(org.apache.logging.log4j.core.LogEvent event)
     
    static <B extends OpenTelemetryAppender.Builder<B>>
    B
     
    static void
    install(io.opentelemetry.api.OpenTelemetry openTelemetry)
    Installs the openTelemetry instance on any OpenTelemetryAppenders identified in the LoggerContext.
    void
    setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)
    Configures the OpenTelemetry used to append logs.

    Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

    error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toString

    Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

    addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, start, stop, stop

    Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

    equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

    getState, initialize, isStarted, isStopped, start, stop
  • Method Details

    • install

      public static void install(io.opentelemetry.api.OpenTelemetry openTelemetry)
      Installs the openTelemetry instance on any OpenTelemetryAppenders identified in the LoggerContext.
    • builder

      @PluginBuilderFactory public static <B extends OpenTelemetryAppender.Builder<B>> B builder()
    • setOpenTelemetry

      public void setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)
      Configures the OpenTelemetry used to append logs. This MUST be called for the appender to function. See install(OpenTelemetry) for simple installation option.
    • append

      public void append(org.apache.logging.log4j.core.LogEvent event)