com.logentries.logback

Class LogentriesAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

com.logentries.logback.LogentriesAppender

All Implemented Interfaces:

ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.LifeCycle

public class LogentriesAppender
extends ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

Logentries appender for logback.

Author:

Mark Lacomber, Ben McCann, Chris Mowforth

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SUFFIX_PATTERN Default Suffix Pattern

Fields inherited from class ch.qos.logback.core.AppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
LogentriesAppender() Creates a new Logentries appender.
LogentriesAppender(AsyncLogger logger) Creates a new Logentries appender.

Method Summary

Modifier and Type	Method and Description
protected void	append(ch.qos.logback.classic.spi.ILoggingEvent event) Implements AppenderSkeleton Append method, handles time and format
ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent>	buildLayout()
java.lang.String	getFacility() Returns the string value of the Facility option.
ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent>	getLayout()
java.lang.String	getSuffixPattern() See {@link #setSuffixPattern(String).
void	setDataHubAddr(java.lang.String dataHubAddr) Sets the address where DataHub server resides.
void	setDataHubPort(int dataHubPort) Sets the port number on which DataHub instance waits for log messages.
void	setDebug(boolean debug) Sets the debug flag.
void	setEncoder(ch.qos.logback.classic.encoder.PatternLayoutEncoder encoder) Sets the suffixPattern to be the field in the .xml configuration file
void	setFacility(java.lang.String facilityStr) The Facility option must be set one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
void	setHostName(java.lang.String hostName) Sets the HostName from the configuration
void	setHttpPut(boolean HttpPut) Sets the HTTP PUTflag.
void	setIsUsingDataHub(boolean useDataHub) Sets the flag which determines if DataHub instance is used instead of Logentries service.
void	setKey(java.lang.String account_key) Sets the ACCOUNT KEY value for HTTP PUT.
void	setLayout(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout) Sets the layout for the Appender
void	setLocation(java.lang.String log_location) Sets the LOCATION value for HTTP PUT.
void	setLogHostName(boolean logHostName) Determines whether to send HostName alongside with the log message
void	setLogID(java.lang.String logID) Sets LogID parameter from the configuration
void	setSsl(boolean ssl) Sets the SSL boolean flag
void	setSuffixPattern(java.lang.String suffixPattern) The suffixPattern option specifies the format of the non-standardized part of the message sent to the syslog server.
void	setToken(java.lang.String token) Sets the token.
void	start()
void	stop() Closes all connections to Logentries

Methods inherited from class ch.qos.logback.core.AppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

DEFAULT_SUFFIX_PATTERN

public static final java.lang.String DEFAULT_SUFFIX_PATTERN

Default Suffix Pattern

See Also:

Constant Field Values

Constructor Detail

LogentriesAppender

public LogentriesAppender()

Creates a new Logentries appender.

LogentriesAppender

public LogentriesAppender(AsyncLogger logger)

Creates a new Logentries appender.

Used for unit testing.

Parameters:

logger - the AsyncLogger to dispatch events

Method Detail

setToken

public void setToken(java.lang.String token)

Sets the token.

Parameters:

token -

setHttpPut

public void setHttpPut(boolean HttpPut)

Sets the HTTP PUTflag.

Send logs via HTTP PUT instead of default Token TCP.

Parameters:

httpput - true to use HTTP PUT API

setKey

public void setKey(java.lang.String account_key)

Sets the ACCOUNT KEY value for HTTP PUT.

Parameters:

account_key -

setLocation

public void setLocation(java.lang.String log_location)

Sets the LOCATION value for HTTP PUT.

Parameters:

log_location -

setSsl

public void setSsl(boolean ssl)

Sets the SSL boolean flag

Parameters:

ssl -

setDebug

public void setDebug(boolean debug)

Sets the debug flag.

Appender in debug mode will print error messages on error console.

Parameters:

debug - debug flag to set

setIsUsingDataHub

public void setIsUsingDataHub(boolean useDataHub)

Sets the flag which determines if DataHub instance is used instead of Logentries service.

Parameters:

useDataHub - set to true to send log messaged to a DataHub instance.

setDataHubAddr

public void setDataHubAddr(java.lang.String dataHubAddr)

Sets the address where DataHub server resides.

Parameters:

dataHubAddr - address like "127.0.0.1"

setDataHubPort

public void setDataHubPort(int dataHubPort)

Sets the port number on which DataHub instance waits for log messages.

Parameters:

dataHubPort -

setLogHostName

public void setLogHostName(boolean logHostName)

Determines whether to send HostName alongside with the log message

Parameters:

logHostName -

setHostName

public void setHostName(java.lang.String hostName)

Sets the HostName from the configuration

Parameters:

hostName -

setLogID

public void setLogID(java.lang.String logID)

Sets LogID parameter from the configuration

Parameters:

logID -

setEncoder

public void setEncoder(ch.qos.logback.classic.encoder.PatternLayoutEncoder encoder)

Sets the suffixPattern to be the field in the .xml configuration file

Parameters:

encoder -

start

public void start()

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

start in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

getFacility

public java.lang.String getFacility()

Returns the string value of the Facility option. See setFacility(java.lang.String) for the set of allowed values.

setFacility

public void setFacility(java.lang.String facilityStr)

The Facility option must be set one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. Case is not important.

See SyslogConstants and RFC 3164 for more information about the Facility option.

setLayout

public void setLayout(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout)

Sets the layout for the Appender

getLayout

public ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> getLayout()

append

protected void append(ch.qos.logback.classic.spi.ILoggingEvent event)

Implements AppenderSkeleton Append method, handles time and format

Specified by:

append in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

stop

public void stop()

Closes all connections to Logentries

Specified by:

stop in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

stop in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

buildLayout

public ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> buildLayout()

getSuffixPattern

public java.lang.String getSuffixPattern()

See {@link #setSuffixPattern(String).

Returns:

setSuffixPattern

public void setSuffixPattern(java.lang.String suffixPattern)

The suffixPattern option specifies the format of the non-standardized part of the message sent to the syslog server.

Parameters:

suffixPattern -