@Plugin(name="GLogFile",
category="Core",
elementType="appender",
printObject=true)
public final class GLogFileAppender
extends org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.rolling.RollingFileManager>
<Appenders>
<GLogFile name="LmsAppender" fileName="applog">
<GLogSegmentationStrategy segmentation="4 hrs"/>
<GLogRolloverStrategy expiration="8 files"/>
<GLmsLayout timeFormat="iso8601" messageFormat="full"/>
</GLogFile>
</Appenders>
I has following attributes:"true"
(default) exceptions encountered when appending events are logged;
otherwise they are propagated to the caller.GLogSegmentationStrategy
is designed to be used here, though, its possible
to use any other Log4j2 triggering policy.
Defaults to the default GLogSegmentationStrategy
.GLogRolloverStrategy
is designed to be used here, though, its possible
to use any other Log4j2 rollover strategy.
Defaults to the default GLogRolloverStrategy
.GLmsLayout
).Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
DEFAULT_LOGDIR_OPT |
The jvm system property name for application logs default root directory.
|
protected static java.lang.String |
LOGFILE_DEF_EXT |
|
protected static java.lang.String |
LOGFILE_SUFFIX_TPL |
Modifier and Type | Method | Description |
---|---|---|
void |
append(org.apache.logging.log4j.core.LogEvent event) |
Write the log entry rolling over the file when required.
|
static GLogFileAppender |
createAppender(java.lang.String name,
java.lang.String fileName,
java.lang.String defaultLogdir,
java.lang.String bufferedIO,
java.lang.String bufferSizeStr,
java.lang.String immediateFlush,
org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy policy,
org.apache.logging.log4j.core.appender.rolling.RolloverStrategy strategy,
org.apache.logging.log4j.core.Layout<? extends java.io.Serializable> layout,
org.apache.logging.log4j.core.Filter filter,
java.lang.String ignore,
java.lang.String advertise,
java.lang.String advertiseURI,
java.nio.charset.Charset charset,
org.apache.logging.log4j.core.config.Configuration config) |
Creates a GLogFileAppender.
|
static GLogFileAppender |
createAppender(java.lang.String name,
java.lang.String fileName,
java.lang.String bufferedIO,
java.lang.String bufferSizeStr,
java.lang.String immediateFlush,
org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy policy,
org.apache.logging.log4j.core.appender.rolling.RolloverStrategy strategy,
org.apache.logging.log4j.core.Layout<? extends java.io.Serializable> layout,
org.apache.logging.log4j.core.Filter filter,
java.lang.String ignore,
java.lang.String advertise,
java.lang.String advertiseURI,
java.nio.charset.Charset charset,
org.apache.logging.log4j.core.config.Configuration config) |
Deprecated.
|
java.lang.String |
getFileName() |
Returns the file name for the appender.
|
java.lang.String |
getFilePattern() |
Returns the file pattern used when rolling over.
|
<T extends org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy> |
getTriggeringPolicy() |
Returns the triggering policy.
|
void |
start() |
|
void |
stop() |
|
boolean |
stop(long timeout,
java.util.concurrent.TimeUnit timeUnit) |
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toString
addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter
equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop
directEncodeEvent, getImmediateFlush, getManager, stop, writeByteArrayToManager
public static final java.lang.String DEFAULT_LOGDIR_OPT
protected static final java.lang.String LOGFILE_DEF_EXT
protected static final java.lang.String LOGFILE_SUFFIX_TPL
public void start()
start
in class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.rolling.RollingFileManager>
public boolean stop(long timeout, java.util.concurrent.TimeUnit timeUnit)
stop
in class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.rolling.RollingFileManager>
public void stop()
stop
in class org.apache.logging.log4j.core.AbstractLifeCycle
public void append(org.apache.logging.log4j.core.LogEvent event)
append
in class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.rolling.RollingFileManager>
event
- The LogEvent.public java.lang.String getFileName()
public java.lang.String getFilePattern()
public <T extends org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy> T getTriggeringPolicy()
T
- TriggeringPolicy type@Deprecated public static GLogFileAppender createAppender(java.lang.String name, java.lang.String fileName, java.lang.String bufferedIO, java.lang.String bufferSizeStr, java.lang.String immediateFlush, org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy policy, org.apache.logging.log4j.core.appender.rolling.RolloverStrategy strategy, org.apache.logging.log4j.core.Layout<? extends java.io.Serializable> layout, org.apache.logging.log4j.core.Filter filter, java.lang.String ignore, java.lang.String advertise, java.lang.String advertiseURI, java.nio.charset.Charset charset, org.apache.logging.log4j.core.config.Configuration config)
@PluginFactory public static GLogFileAppender createAppender(@PluginAttribute("name") java.lang.String name, @PluginAttribute("fileName") java.lang.String fileName, @PluginAttribute("defaultLogdir") java.lang.String defaultLogdir, @PluginAttribute("bufferedIO") java.lang.String bufferedIO, @PluginAttribute("bufferSize") java.lang.String bufferSizeStr, @PluginAttribute("immediateFlush") java.lang.String immediateFlush, @PluginElement("Policy") org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy policy, @PluginElement("Strategy") org.apache.logging.log4j.core.appender.rolling.RolloverStrategy strategy, @PluginElement("Layout") org.apache.logging.log4j.core.Layout<? extends java.io.Serializable> layout, @PluginElement("Filter") org.apache.logging.log4j.core.Filter filter, @PluginAttribute("ignoreExceptions") java.lang.String ignore, @PluginAttribute("advertise") java.lang.String advertise, @PluginAttribute("advertiseURI") java.lang.String advertiseURI, @PluginAttribute(value="charset",defaultString="UTF-8") java.nio.charset.Charset charset, @PluginConfiguration org.apache.logging.log4j.core.config.Configuration config)
name
- The name of the Appender (required).fileName
- The name of the file that is actively written to. (required).defaultLogdir
- The default root directory for log files.bufferedIO
- When true, I/O will be buffered. Defaults to "true".bufferSizeStr
- buffer size for buffered IO (default is 8192).immediateFlush
- When true, events are immediately flushed. Defaults to "true".policy
- The rollover triggering policy (defaults to the default GLogSegmentationStrategy
).strategy
- The rollover strategy (defaults to the default GLogRolloverStrategy
).layout
- The layout to use (defaults to the default GLmsLayout
).filter
- The Filter or null.ignore
- If "true"
(default) exceptions encountered when appending events are logged; otherwise
they are propagated to the caller.advertise
- "true" if the appender configuration should be advertised, "false" otherwise.advertiseURI
- The advertised URI which can be used to retrieve the file contents.charset
- the charset encoding to write the log files with. Default value is "UTF-8".config
- The Configuration.Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.