You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by sw...@apache.org on 2024/05/29 03:20:41 UTC
(logging-log4cxx) branch property_config_syntax created (now 5ff98808)
This is an automated email from the ASF dual-hosted git repository.
swebb2066 pushed a change to branch property_config_syntax
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
at 5ff98808 Improve documentation of the property file configuration syntax
This branch includes the following new commits:
new 5ff98808 Improve documentation of the property file configuration syntax
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(logging-log4cxx) 01/01: Improve documentation of the property file configuration syntax
Posted by sw...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
swebb2066 pushed a commit to branch property_config_syntax
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
commit 5ff988082e2d4d60c8a9a9763243bc4e741562ca
Author: Stephen Webb <sw...@gmail.com>
AuthorDate: Wed May 29 13:20:20 2024 +1000
Improve documentation of the property file configuration syntax
---
src/main/include/log4cxx/propertyconfigurator.h | 363 ++++++++++++------------
1 file changed, 180 insertions(+), 183 deletions(-)
diff --git a/src/main/include/log4cxx/propertyconfigurator.h b/src/main/include/log4cxx/propertyconfigurator.h
index b8d47db7..5b9bf219 100644
--- a/src/main/include/log4cxx/propertyconfigurator.h
+++ b/src/main/include/log4cxx/propertyconfigurator.h
@@ -48,27 +48,159 @@ typedef std::shared_ptr<LoggerFactory> LoggerFactoryPtr;
class PropertyWatchdog;
/**
Allows the configuration of log4cxx from an external file.
-See {@link PropertyConfigurator#doConfigure doConfigure} for the expected format.
-<p>It is sometimes useful to see how log4cxx is reading configuration
-files. You can enable log4cxx internal logging by defining the
-<b>log4j.debug</b> variable.
+\anchor PropertyConfigurator_details
+The configuration file consists of statements in the format
+<code>key=value</code>.
+A line beginning with a <code>#</code> or <code>!</code> character
+is ignored by %log4cxx (use for a comment).
+The syntax of different configuration
+elements are discussed below.
-<P>At class initialization time class,
-the file <b>log4j.properties</b> will be searched in the current directory.
-If the file can be found, then it will
-be fed to the
-{@link PropertyConfigurator#configure(const File& configFilename) configure}
-method.
-
-<p>The <code>PropertyConfigurator</code> does not handle the
+The <code>PropertyConfigurator</code> does not handle the
advanced configuration features supported by the
{@link xml::DOMConfigurator DOMConfigurator} such as
support for {@link spi::Filter Filters}, custom
{@link spi::ErrorHandler ErrorHandlers}, nested
appenders such as the {@link AsyncAppender AsyncAppender}, etc.
-<p>All option <em>values</em> admit variable substitution. The
+<h3>Appender configuration</h3>
+
+Appender configuration syntax is:
+<pre>
+# For appender named <i>appenderName</i>, set its class.
+# Note: The appender name can contain dots.
+log4j.appender.appenderName=fully.qualified.name.of.appender.class
+
+# Set appender specific options.
+log4j.appender.appenderName.option1=value1
+...
+log4j.appender.appenderName.optionN=valueN
+</pre>
+
+For each named appender you can configure its {@link Layout Layout}. The
+syntax for configuring an appender's layout is:
+<pre>
+log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
+log4j.appender.appenderName.layout.option1=value1
+....
+log4j.appender.appenderName.layout.optionN=valueN
+</pre>
+
+Refer to the Appender::setOption override of each implemented appender and
+Layout::setOption override of each implemented layout
+for class specific options.
+
+<h3>Configuring loggers</h3>
+
+The syntax for configuring the root logger is:
+<pre>
+log4j.rootLogger=[level], appenderName, appenderName, ...
+</pre>
+
+This syntax means that an optional <em>level</em> can be
+supplied followed by appender names separated by commas.
+
+The level value can consist of the string values OFF, FATAL,
+ERROR, WARN, INFO, DEBUG, ALL or a <em>custom level</em> value. A
+custom level value can be specified in the form
+<code>level#classname</code>.
+
+If a level value is specified, then the root level is set
+to the corresponding level. If no level value is specified,
+then the root level remains untouched.
+
+The root logger can be assigned multiple appenders.
+
+Each <i>appenderName</i> (separated by commas) will be added to
+the root logger. The named appender is defined using the
+appender syntax defined above.
+
+For non-root categories the syntax is almost the same:
+<pre>
+log4j.logger.logger_name=[level|INHERITED|NULL], appenderName, appenderName,
+...
+</pre>
+
+The meaning of the optional level value is discussed above
+in relation to the root logger. In addition however, the value
+INHERITED can be specified meaning that the named logger should
+inherit its level from the logger hierarchy.
+
+If no level value is supplied, then the level of the
+named logger remains untouched.
+
+By default categories inherit their level from the
+hierarchy. However, if you set the level of a logger and later
+decide that that logger should inherit its level, then you should
+specify INHERITED as the value for the level value. NULL is a
+synonym for INHERITED.
+
+Similar to the root logger syntax, each <i>appenderName</i>
+(separated by commas) will be attached to the named logger.
+
+See the <a href="concepts.html#appender-additivity">appender
+additivity rule</a> in the usage guide for the meaning of the
+<code>additivity</code> flag.
+
+<h3>Example</h3>
+
+An example configuration is given below.
+
+<pre>
+# Set options for appender named "A1".
+# Appender "A1" will be a SyslogAppender
+log4j.appender.A1=SyslogAppender
+
+# The syslog daemon resides on www.abc.net
+log4j.appender.A1.SyslogHost=www.abc.net
+
+# A1's layout is a PatternLayout, using the conversion pattern
+# "%r %-5p %c{2} %M.%L %x - %m%n". Thus, the log output will include
+# the relative time since the start of the application in milliseconds, followed by
+# the level of the log request, followed by
+# the two rightmost components of the logger name, followed by
+# the callers method name, followed by the line number,
+# the nested disgnostic context and finally the message itself.
+# Refer to the documentation of PatternLayout for further information
+# on the syntax of the ConversionPattern key.
+log4j.appender.A1.layout=PatternLayout
+log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %%c{2} %%M.%%L %%x - %%m%%n
+
+# Set options for appender named "A2"
+# A2 should be a RollingFileAppender,
+# with maximum file size of 10 MB using at most one backup file.
+# A2's layout is: date and time (using the ISO8061 date format),
+# thread, level, logger name, nested diagnostic context
+# and finally the message itself.
+log4j.appender.A2=RollingFileAppender
+log4j.appender.A2.MaxFileSize=10MB
+log4j.appender.A2.MaxBackupIndex=1
+log4j.appender.A2.layout=PatternLayout
+log4j.appender.A2.layout.ConversionPattern=%%d [%%t] %%p %%c %%x - %%m%%n
+
+# Root logger set to DEBUG using the A2 appender defined above.
+log4j.rootLogger=DEBUG, A2
+
+# Logger definitions:
+# The SECURITY logger inherits is level from root. However, it's output
+# will go to A1 appender defined above. It's additivity is non-cumulative.
+log4j.logger.SECURITY=INHERIT, A1
+log4j.additivity.SECURITY=false
+
+# Only warnings or above will be logged for the logger "SECURITY.access".
+# Output will go to A1.
+log4j.logger.SECURITY.access=WARN
+
+# The logger "class.of.the.day" inherits its level from the
+# logger hierarchy. Output will go to the appender's of the root
+# logger, A2 in this case.
+log4j.logger.class.of.the.day=INHERIT
+</pre>
+
+<h3>Dynamic option values</h3>
+
+All option <em>values</em> admit variable substitution. The
syntax of variable substitution is similar to that of Unix
shells. The string between an opening <b>"${"</b> and
closing <b>"}"</b> is interpreted as a key. The value of
@@ -77,10 +209,41 @@ the configuration file itself. The value of the key is first
searched in the system properties, and if not found there, it is
then searched in the configuration file being parsed. The
corresponding value replaces the ${variableName} sequence. For
-example, if <code>java.home</code> system property is set to
+example, if <code>home</code> system property is set to
<code>/home/xyz</code>, then every occurrence of the sequence
-<code>${java.home}</code> will be interpreted as
+<code>${home}</code> will be interpreted as
<code>/home/xyz</code>.
+
+<h3>Repository-wide threshold</h3>
+
+The repository-wide threshold filters logging requests by level
+regardless of logger. The syntax is:
+
+<pre>
+log4j.threshold=[level]
+</pre>
+
+The level value can consist of the string values OFF, FATAL,
+ERROR, WARN, INFO, DEBUG, ALL or a <em>custom level</em> value. A
+custom level value can be specified in the form
+level#classname. By default the repository-wide threshold is set
+to the lowest possible value, namely the level <code>ALL</code>.
+
+<h3>Debugging</h3>
+
+It is sometimes useful to see how %log4cxx is reading configuration
+files. You can <a href="internal-debugging.html">enable %log4cxx internal logging</a>
+by defining the <b>log4j.debug</b> variable in the property file.
+<pre>
+# Enable internal logging
+log4j.debug=true
+</pre>
+
+<h3>Logger Factories</h3>
+
+The usage of custom logger factories is discouraged and no longer
+documented.
+
*/
class LOG4CXX_EXPORT PropertyConfigurator :
virtual public spi::Configurator,
@@ -118,172 +281,6 @@ class LOG4CXX_EXPORT PropertyConfigurator :
resetConfiguration} method before calling
<code>doConfigure</code>.
- <p>The configuration file consists of statements in the format
- <code>key=value</code>. The syntax of different configuration
- elements are discussed below.
-
- <h3>Repository-wide threshold</h3>
-
- <p>The repository-wide threshold filters logging requests by level
- regardless of logger. The syntax is:
-
- <pre>
- log4j.threshold=[level]
- </pre>
-
- <p>The level value can consist of the string values OFF, FATAL,
- ERROR, WARN, INFO, DEBUG, ALL or a <em>custom level</em> value. A
- custom level value can be specified in the form
- level#classname. By default the repository-wide threshold is set
- to the lowest possible value, namely the level <code>ALL</code>.
- </p>
-
-
- <h3>Appender configuration</h3>
-
- <p>Appender configuration syntax is:
- <pre>
- # For appender named <i>appenderName</i>, set its class.
- # Note: The appender name can contain dots.
- log4j.appender.appenderName=fully.qualified.name.of.appender.class
-
- # Set appender specific options.
- log4j.appender.appenderName.option1=value1
- ...
- log4j.appender.appenderName.optionN=valueN
- </pre>
-
- For each named appender you can configure its {@link Layout Layout}. The
- syntax for configuring an appender's layout is:
- <pre>
- log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
- log4j.appender.appenderName.layout.option1=value1
- ....
- log4j.appender.appenderName.layout.optionN=valueN
- </pre>
-
- <h3>Configuring loggers</h3>
-
- <p>The syntax for configuring the root logger is:
- <pre>
- log4j.rootLogger=[level], appenderName, appenderName, ...
- </pre>
-
- <p>This syntax means that an optional <em>level</em> can be
- supplied followed by appender names separated by commas.
-
- <p>The level value can consist of the string values OFF, FATAL,
- ERROR, WARN, INFO, DEBUG, ALL or a <em>custom level</em> value. A
- custom level value can be specified in the form
- <code>level#classname</code>.
-
- <p>If a level value is specified, then the root level is set
- to the corresponding level. If no level value is specified,
- then the root level remains untouched.
-
- <p>The root logger can be assigned multiple appenders.
-
- <p>Each <i>appenderName</i> (separated by commas) will be added to
- the root logger. The named appender is defined using the
- appender syntax defined above.
-
- <p>For non-root categories the syntax is almost the same:
- <pre>
- log4j.logger.logger_name=[level|INHERITED|NULL], appenderName, appenderName,
- ...
- </pre>
-
- <p>The meaning of the optional level value is discussed above
- in relation to the root logger. In addition however, the value
- INHERITED can be specified meaning that the named logger should
- inherit its level from the logger hierarchy.
-
- <p>If no level value is supplied, then the level of the
- named logger remains untouched.
-
- <p>By default categories inherit their level from the
- hierarchy. However, if you set the level of a logger and later
- decide that that logger should inherit its level, then you should
- specify INHERITED as the value for the level value. NULL is a
- synonym for INHERITED.
-
- <p>Similar to the root logger syntax, each <i>appenderName</i>
- (separated by commas) will be attached to the named logger.
-
- <p>See the <a href="Introduction.html#additivity">appender
- additivity rule</a> in the user manual for the meaning of the
- <code>additivity</code> flag.
-
- <h3>Logger Factories</h3>
-
- The usage of custom logger factories is discouraged and no longer
- documented.
-
- <h3>Example</h3>
-
- <p>An example configuration is given below. Other configuration
- file examples are given in the <code>examples</code> folder.
-
- <pre>
-
- # Set options for appender named "A1".
- # Appender "A1" will be a SyslogAppender
- log4j.appender.A1=SyslogAppender
-
- # The syslog daemon resides on www.abc.net
- log4j.appender.A1.SyslogHost=www.abc.net
-
- # A1's layout is a PatternLayout, using the conversion pattern
- # "%r %-5p %c{2} %M.%L %x - %m%n". Thus, the log output will include
- # the relative time since the start of the application in milliseconds, followed by
- # the level of the log request, followed by
- # the two rightmost components of the logger name, followed by
- # the callers method name, followed by the line number,
- # the nested disgnostic context and finally the message itself.
- # Refer to the documentation of PatternLayout for further information
- # on the syntax of the ConversionPattern key.
- log4j.appender.A1.layout=PatternLayout
- log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %%c{2} %%M.%%L %%x - %%m%%n
-
- # Set options for appender named "A2"
- # A2 should be a RollingFileAppender,
- # with maximum file size of 10 MB using at most one backup file.
- # A2's layout is: date and time (using the ISO8061 date format),
- # thread, level, logger name, nested diagnostic context
- # and finally the message itself.
- log4j.appender.A2=RollingFileAppender
- log4j.appender.A2.MaxFileSize=10MB
- log4j.appender.A2.MaxBackupIndex=1
- log4j.appender.A2.layout=PatternLayout
- log4j.appender.A2.layout.ConversionPattern=%%d [%%t] %%p %%c %%x - %%m%%n
-
- # Root logger set to DEBUG using the A2 appender defined above.
- log4j.rootLogger=DEBUG, A2
-
- # Logger definitions:
- # The SECURITY logger inherits is level from root. However, it's output
- # will go to A1 appender defined above. It's additivity is non-cumulative.
- log4j.logger.SECURITY=INHERIT, A1
- log4j.additivity.SECURITY=false
-
- # Only warnings or above will be logged for the logger "SECURITY.access".
- # Output will go to A1.
- log4j.logger.SECURITY.access=WARN
-
-
- # The logger "class.of.the.day" inherits its level from the
- # logger hierarchy. Output will go to the appender's of the root
- # logger, A2 in this case.
- log4j.logger.class.of.the.day=INHERIT
- </pre>
-
- <p>Refer to the <b>setOption</b> method in each Appender and
- Layout for class specific options.
-
- <p>Use the <code>#</code> or <code>!</code> characters at the
- beginning of a line for comments.
-
- <p>
@param configFileName The name of the configuration file where the
configuration information is stored.
@param hierarchy The hierarchy to operation upon.
@@ -325,14 +322,14 @@ class LOG4CXX_EXPORT PropertyConfigurator :
/**
Read configuration options from <code>properties</code>.
- See {@link PropertyConfigurator#doConfigure doConfigure}
+ See the \ref PropertyConfigurator_details "detailed description"
for the expected format.
*/
static spi::ConfigurationStatus configure(helpers::Properties& properties);
/**
Read configuration options from <code>properties</code>.
- See {@link PropertyConfigurator#doConfigure doConfigure}
+ See the \ref PropertyConfigurator_details "detailed description"
for the expected format.
*/
spi::ConfigurationStatus doConfigure(helpers::Properties& properties,