Skip to content

Commit

Permalink
LOGCXX-571 Env and macro documentation updates (#162)
Browse files Browse the repository at this point in the history
Create new pages that explicitly list out all of the macros and environment
variables that can be set in order to influence Log4cxx.
  • Loading branch information
rm5248 committed Dec 19, 2022
1 parent 82485f4 commit f6810ea
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/site/markdown/1-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ See the following pages for usage information:
* @subpage performance
* @subpage map-filter
* @subpage multiprocess-logging
* @subpage environment-variables
* @subpage macros-influencing-log4cxx
38 changes: 38 additions & 0 deletions src/site/markdown/environment-variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Environment Variables {#environment-variables}
===
<!--
Note: License header cannot be first, as doxygen does not generate
cleanly if it before the '==='
-->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# Environment Variables Used by Log4cxx

There are several environment variables that can be set in order to influence how
Log4cxx works. They are summarized in the following table:


| Environment Variable | Usage |
| -------------------- | ----- |
| LOG4CXX\_DEBUG | Set to the value 'true' to enable internal debugging of Log4cxx. All output goes to stderr. This can be useful to determine why a configuration file is not loading |
| log4j.configuratorClass | Used to determine what class to use to configure the logging system |
| LOG4CXX\_CONFIGURATOR\_CLASS | Used to determine what class to use to configure the logging system. Takes precedence over log4j.configuratorClass |
| log4j.configuration | Set the file to load to configure the logging system |
| LOG4CXX\_CONFIGURATION | Set the file to load to configure the logging system. Takes precedence over log4j.configuration |
| LOG4CXX\_CONFIGURATION\_WATCH\_SECONDS | Set how often the configuration file should be checked for changes |

35 changes: 35 additions & 0 deletions src/site/markdown/macros-influencing-log4cxx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Macros Influencing Log4cxx {#macros-influencing-log4cxx}
===
<!--
Note: License header cannot be first, as doxygen does not generate
cleanly if it before the '==='
-->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# Macros that influence Log4cxx

The following macros can be defined in client code to influence how log messages
are set or not.

These macros may be set on a per-file basis(in which case they must be before any
Log4cxx includes), or they may be set globally via your build system.

| Macro | Usage |
| ----- | ----- |
| LOG4CXX\_THRESHOLD | Used to determine if log messages are compiled in or not. A higher value causes more messages to be compiled out. See [removing log statements](usage.html#removing-log-statements) for more information. |
| LOG4CXX\_DISABLE\_LOCATION\_INFO | Define this macro to disable location information on log statements. Location information includes the filename, class name, method name, and line number |

0 comments on commit f6810ea

Please sign in to comment.