edu.fhda.log4j.net

Class PapertrailAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

edu.fhda.log4j.net.PapertrailAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class PapertrailAppender
extends org.apache.log4j.AppenderSkeleton

The PapertrailAppender sends logger events directly to Papertrail (papertrailapp.com) using TCP over TLS. Designed as an alternative to the packaged Log4j SyslogAppender for applications deployed on a private network where outgoing UDP connections (such as for syslog) are blocked by the network policy. blocked.

Version:

1.0

Author:

Matt Rapczynski, Foothill-De Anza College District

Field Summary

Fields

Modifier and Type	Field and Description
int	MAX_MESSAGE_SIZE Constant to be used in trimming log messages to hard limit of 8 kilobytes as specified in the Papertrail support documentation.

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
PapertrailAppender() Create a new unconfigured PapertrailAppender instance.
PapertrailAppender(String name, String hostname, int port, org.apache.log4j.Layout layout) Create a new PapertrailAppender instance with a configurable name, host, port, and layout.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	append(org.apache.log4j.spi.LoggingEvent loggingEvent) Perform the actual action of appending a log event.
void	close()
String	getPapertrailHost()
int	getPapertrailPort()
boolean	requiresLayout()
void	setPapertrailHost(String papertrailHost)
void	setPapertrailPort(int papertrailPort)

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Field Detail

MAX_MESSAGE_SIZE

public final int MAX_MESSAGE_SIZE

Constant to be used in trimming log messages to hard limit of 8 kilobytes as specified in the Papertrail support documentation.

See Also:

Constant Field Values

Constructor Detail

PapertrailAppender

public PapertrailAppender()

Create a new unconfigured PapertrailAppender instance.

PapertrailAppender

public PapertrailAppender(String name,
                  String hostname,
                  int port,
                  org.apache.log4j.Layout layout)

Create a new PapertrailAppender instance with a configurable name, host, port, and layout.

Parameters:

name - The name to use for the appender

hostname - The remote hostname for connecting to Papertrail

port - The remote port to use for connecting to Papertrail

layout - A Layout instance for formatting log messages

Method Detail

append

protected void append(org.apache.log4j.spi.LoggingEvent loggingEvent)

Perform the actual action of appending a log event.

Specified by:

append in class org.apache.log4j.AppenderSkeleton

Parameters:

loggingEvent - The LoggingEvent object to be appended.

close

public void close()

requiresLayout

public boolean requiresLayout()

getPapertrailHost

public String getPapertrailHost()

setPapertrailHost

public void setPapertrailHost(String papertrailHost)

getPapertrailPort

public int getPapertrailPort()

setPapertrailPort

public void setPapertrailPort(int papertrailPort)