public class LogFilePatternReceiver extends Receiver
This receiver relies on java.util.regex features to perform the parsing of text in the log file, however the only regular expression field explicitly supported is a glob-style wildcard used to ignore fields in the log file if needed. All other fields are parsed by using the supplied keywords.
Features:
- specify the URL of the log file to be processed
- specify the timestamp format in the file (if one exists, using patterns from SimpleDateFormat)
- specify the pattern (logFormat) used in the log file using keywords, a wildcard character (*) and fixed text
- 'tail' the file (allows the contents of the file to be continually read and new events processed)
- supports the parsing of multi-line messages and exceptions
- 'hostname' property set to URL host (or 'file' if not available)
- 'application' property set to URL path (or value of fileURL if not available)
- 'group' property can be set to associate multiple log file receivers
Keywords:
TIMESTAMP
LOGGER
LEVEL
THREAD
CLASS
FILE
LINE
METHOD
RELATIVETIME
MESSAGE
NDC
PROP(key)
(NL)
(NL) represents a new line embedded in the log format, supporting log formats whose fields span multiple lines
Use a * to ignore portions of the log format that should be ignored
Example:
If your file's patternlayout is this:
%d %-5p [%t] %C{2} (%F:%L) - %m%n
specify this as the log format:
TIMESTAMP LEVEL [THREAD] CLASS (FILE:LINE) - MESSAGE
To define a PROPERTY field, use PROP(key)
Example:
If you used the RELATIVETIME pattern layout character in the file,
you can use PROP(RELATIVETIME) in the logFormat definition to assign
the RELATIVETIME field as a property on the event.
If your file's patternlayout is this:
%r [%t] %-5p %c %x - %m%n
specify this as the log format:
PROP(RELATIVETIME) [THREAD] LEVEL LOGGER * - MESSAGE
Note the * - it can be used to ignore a single word or sequence of words in the log file (in order for the wildcard to ignore a sequence of words, the text being ignored must be followed by some delimiter, like '-' or '[') - ndc is being ignored in the following example.
Assign a filterExpression in order to only process events which match a filter. If a filterExpression is not assigned, all events are processed.
Limitations:
- no support for the single-line version of throwable supported by patternlayout
(this version of throwable will be included as the last line of the message)
- the relativetime patternLayout character must be set as a property: PROP(RELATIVETIME)
- messages should appear as the last field of the logFormat because the variability in message content
- exceptions are converted if the exception stack trace (other than the first line of the exception)
is stored in the log file with a tab followed by the word 'at' as the first characters in the line
- tailing may fail if the file rolls over.
Example receiver configuration settings (add these as params, specifying a LogFilePatternReceiver 'plugin'):
param: "timestampFormat" value="yyyy-MM-d HH:mm:ss,SSS"
param: "logFormat" value="PROP(RELATIVETIME) [THREAD] LEVEL LOGGER * - MESSAGE"
param: "fileURL" value="file:///c:/events.log"
param: "tailing" value="true"
This configuration will be able to process these sample events:
710 [ Thread-0] DEBUG first.logger first - <test> <test2>something here</test2> <test3 blah=something/> <test4> <test5>something else</test5> </test4></test>
880 [ Thread-2] DEBUG first.logger third - <test> <test2>something here</test2> <test3 blah=something/> <test4> <test5>something else</test5> </test4></test>
880 [ Thread-0] INFO first.logger first - infomsg-0
java.lang.Exception: someexception-first
at Generator2.run(Generator2.java:102)
| Modifier and Type | Field and Description |
|---|---|
static int |
MISSING_FILE_RETRY_MILLIS |
thresholdLevelactive, namerepository| Constructor and Description |
|---|
LogFilePatternReceiver() |
| Modifier and Type | Method and Description |
|---|---|
void |
activateOptions()
Read and process the log file.
|
protected void |
createPattern() |
String |
getCustomLevelDefinitions() |
String |
getFileURL()
Accessor
|
String |
getFilterExpression()
Accessor
|
String |
getGroup()
Accessor
|
String |
getLogFormat()
Accessor
|
String |
getPath() |
String |
getTimestampFormat()
Accessor
|
long |
getWaitMillis()
Accessor
|
protected void |
initialize()
Build the regular expression needed to parse log entries
|
boolean |
isAppendNonMatches()
Accessor
|
boolean |
isTailing()
Accessor
|
boolean |
isUseCurrentThread()
When true, this property uses the current Thread to perform the import,
otherwise when false (the default), a new Thread is created and started to manage
the import.
|
protected void |
process(BufferedReader bufferedReader)
Read, parse and optionally tail the log file, converting entries into logging events.
|
void |
setAppendNonMatches(boolean appendNonMatches)
Mutator
|
void |
setCustomLevelDefinitions(String customLevelDefinitions)
If the log file contains non-log4j level strings, they can be mapped to log4j levels using the format (android example):
V=TRACE,D=DEBUG,I=INFO,W=WARN,E=ERROR,F=FATAL,S=OFF
|
void |
setFileURL(String fileURL)
Mutator
|
void |
setFilterExpression(String filterExpression)
Mutator
|
void |
setGroup(String group)
Mutator
|
protected void |
setHost(String host) |
void |
setLogFormat(String logFormat)
Mutator
|
protected void |
setPath(String path) |
void |
setTailing(boolean tailing)
Mutator
|
void |
setTimestampFormat(String timestampFormat)
Mutator.
|
void |
setUseCurrentThread(boolean useCurrentThread)
Sets whether the current Thread or a new Thread is created to perform the import,
the default being false (new Thread created).
|
void |
setWaitMillis(long waitMillis)
Mutator
|
void |
shutdown()
Close the reader.
|
doPost, getThreshold, isAsSevereAsThreshold, setThresholdaddPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getLoggerRepository, getName, isActive, isEquivalent, removePropertyChangeListener, removePropertyChangeListener, setLoggerRepository, setNamegetLogger, getNonFloodingLogger, resetErrorCountpublic static final int MISSING_FILE_RETRY_MILLIS
public String getFileURL()
public void setFileURL(String fileURL)
fileURL - public void setCustomLevelDefinitions(String customLevelDefinitions)
customLevelDefinitions - the level definition stringpublic String getCustomLevelDefinitions()
public boolean isAppendNonMatches()
public void setAppendNonMatches(boolean appendNonMatches)
appendNonMatches - public String getFilterExpression()
public void setFilterExpression(String filterExpression)
filterExpression - public boolean isTailing()
public void setTailing(boolean tailing)
tailing - public final boolean isUseCurrentThread()
public final void setUseCurrentThread(boolean useCurrentThread)
useCurrentThread - public String getLogFormat()
public void setLogFormat(String logFormat)
logFormat - the formatpublic void setGroup(String group)
public String getGroup()
public void setTimestampFormat(String timestampFormat)
SimpleDateFormattimestampFormat - public String getTimestampFormat()
public long getWaitMillis()
public void setWaitMillis(long waitMillis)
waitMillis - protected void process(BufferedReader bufferedReader) throws IOException
bufferedReader - IOExceptionprotected void createPattern()
protected void setHost(String host)
protected void setPath(String path)
public String getPath()
protected void initialize()
public void shutdown()
public void activateOptions()
Copyright © 2002-2017 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache Chainsaw, Chainsaw, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.