com.microsoft.applicationinsights.log4j.v2

Class ApplicationInsightsAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

com.microsoft.applicationinsights.log4j.v2.ApplicationInsightsAppender

All Implemented Interfaces:

java.io.Serializable, org.apache.logging.log4j.core.Appender, org.apache.logging.log4j.core.filter.Filterable, org.apache.logging.log4j.core.LifeCycle

@Plugin(name="ApplicationInsightsAppender",
        category="Core",
        elementType="appender")
public class ApplicationInsightsAppender
extends org.apache.logging.log4j.core.appender.AbstractAppender

See Also:

Serialized Form

Nested Class Summary

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

LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationInsightsAppender(java.lang.String name, java.lang.String instrumentationKey) Constructs new Application Insights appender.

Method Summary

Modifier and Type	Method and Description
void	append(org.apache.logging.log4j.core.LogEvent event) Logs a LogEvent using whatever logic this Appender wishes to use.
static ApplicationInsightsAppender	createAppender(java.lang.String name, java.lang.String instrumentationKey) Creates new appender with the given name and instrumentation key.
LogTelemetryClientProxy	getTelemetryClientProxy()
void	start() This method is being called on object initialization.

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

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

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

addFilter, getFilter, hasFilter, isFiltered, removeFilter, stop

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

equals, getState, hashCode, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isStarted, isStopped, stop

Constructor Detail

ApplicationInsightsAppender

protected ApplicationInsightsAppender(java.lang.String name,
                                      java.lang.String instrumentationKey)

Constructs new Application Insights appender.

Parameters:

name - The appender name.

instrumentationKey - The instrumentation key.

Method Detail

getTelemetryClientProxy

public LogTelemetryClientProxy getTelemetryClientProxy()

createAppender

@PluginFactory
public static ApplicationInsightsAppender createAppender(@PluginAttribute(value="name")
                                                                         java.lang.String name,
                                                                         @PluginAttribute(value="instrumentationKey")
                                                                         java.lang.String instrumentationKey)

Creates new appender with the given name and instrumentation key. This method is being called on the application startup upon Log4j system initialization.

Parameters:

name - The appender name.

instrumentationKey - The instrumentation key.

Returns:

New Application Insights appender.

append

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

Logs a LogEvent using whatever logic this Appender wishes to use. It is typically recommended to use a bridge pattern not only for the benefits from decoupling an Appender from its implementation, but it is also handy for sharing resources which may require some form of locking.

Parameters:

event - The LogEvent.

start

public void start()

This method is being called on object initialization.

Specified by:

start in interface org.apache.logging.log4j.core.LifeCycle

Overrides:

start in class org.apache.logging.log4j.core.filter.AbstractFilterable