Package com.splunk.logging

Class HttpEventCollectorLog4jAppender

java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
com.splunk.logging.HttpEventCollectorLog4jAppender
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="SplunkHttp",
        category="Core",
        elementType="appender",
        printObject=true)
public final class HttpEventCollectorLog4jAppender
extends org.apache.logging.log4j.core.appender.AbstractAppender
Splunk Http Appender.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

    org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B extends org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B>>

    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)
    Perform Appender specific appending actions.
    static HttpEventCollectorLog4jAppender createAppender​(String url, String token, String channel, String type, String name, String source, String sourcetype, String messageFormat, String host, String index, String ignoreExceptions, String batchSize, String batchCount, String batchInterval, String retriesOnError, String sendMode, String middleware, String disableCertificateValidation, String eventBodySerializer, boolean includeLoggerName, boolean includeThreadName, boolean includeMDC, boolean includeException, boolean includeMarker, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.Filter filter)
    Create a Http Appender.
    boolean stop​(long timeout, TimeUnit timeUnit)  

    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

    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

    • createAppender

      @PluginFactory public static HttpEventCollectorLog4jAppender createAppender​(@PluginAttribute("url") String url, @PluginAttribute("token") String token, @PluginAttribute("channel") String channel, @PluginAttribute("type") String type, @PluginAttribute("name") String name, @PluginAttribute("source") String source, @PluginAttribute("sourcetype") String sourcetype, @PluginAttribute("messageFormat") String messageFormat, @PluginAttribute("host") String host, @PluginAttribute("index") String index, @PluginAttribute(value="ignoreExceptions",defaultBoolean=true) String ignoreExceptions, @PluginAttribute("batch_size_bytes") String batchSize, @PluginAttribute("batch_size_count") String batchCount, @PluginAttribute("batch_interval") String batchInterval, @PluginAttribute("retries_on_error") String retriesOnError, @PluginAttribute("send_mode") String sendMode, @PluginAttribute("middleware") String middleware, @PluginAttribute("disableCertificateValidation") String disableCertificateValidation, @PluginAttribute("eventBodySerializer") String eventBodySerializer, @PluginAttribute(value="includeLoggerName",defaultBoolean=true) boolean includeLoggerName, @PluginAttribute(value="includeThreadName",defaultBoolean=true) boolean includeThreadName, @PluginAttribute(value="includeMDC",defaultBoolean=true) boolean includeMDC, @PluginAttribute(value="includeException",defaultBoolean=true) boolean includeException, @PluginAttribute(value="includeMarker",defaultBoolean=true) boolean includeMarker, @PluginElement("Layout") org.apache.logging.log4j.core.Layout<? extends Serializable> layout, @PluginElement("Filter") org.apache.logging.log4j.core.Filter filter)
      Create a Http Appender.
      Returns:
      The Http Appender.

    • append

      public void append​(org.apache.logging.log4j.core.LogEvent event)
      Perform Appender specific appending actions.
      Parameters:
      event - The Log event.

    • stop

      public boolean stop​(long timeout, TimeUnit timeUnit)
      Specified by:
      stop in interface org.apache.logging.log4j.core.LifeCycle2
      Overrides:
      stop in class org.apache.logging.log4j.core.filter.AbstractFilterable