Skip to content

Commit 4c0930a

Browse files
committed
Add id to each section
1 parent 928d23b commit 4c0930a

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

src/site/antora/modules/ROOT/pages/manual/_properties.adoc

+28-8
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
See the License for the specific language governing permissions and
1515
limitations under the License.
1616
////
17-
[#SystemProperties]
18-
= Global configuration properties
17+
[id=system-properties]
18+
= Configuration properties
1919
2020
Log4j contains a simple configuration properties sub-system that aggregates data from multiple property sources, such as Java https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html[System Properties] and https://docs.oracle.com/javase/tutorial/essential/environment/env.html[Environment Variables].
2121
See <<property-sources>> for a complete list of supported sources
@@ -58,16 +58,19 @@ In case of problems with the properties sub-system, make sure that your applicat
5858
and that all the properties names that start with `log4j` use the normalized form provided by the tables below.
5959
====
6060
61+
[id=properties-meta]
6162
== Meta configuration properties
6263
6364
In order to rapidly optimize Log4j Core for a particular usage, you can use the following properties:
6465
6566
include::partial$properties-meta.adoc[leveloffset=+1]
6667
68+
[id=properties-log4j-api]
6769
== Log4j API properties
6870
6971
The services included in the `log4j-api` module can be configured exclusively through configuration properties.
7072
73+
[id=properties-loader-util]
7174
=== LoaderUtil
7275
7376
The `LoaderUtil` class is used to load classes specified by the user using a fully qualified class name.
@@ -77,13 +80,15 @@ It has only one configuration property:
7780
7881
include::partial$properties-loader-util.adoc[leveloffset=+2]
7982
83+
[id=properties-provider]
8084
=== Provider
8185
8286
The runtime classpath of an application **should** contain only a single implementation of the Log4j API.
8387
In the particular case, when multiple implementations are present, you can select a specific implementation using these properties:
8488
8589
include::partial$properties-provider.adoc[leveloffset=+2]
8690
91+
[id=properties-status-logger]
8792
=== Status Logger
8893
8994
NOTE: To configure status logger you can also place its configuration in a file named `log4j2.StatusLogger.properties`.
@@ -93,6 +98,7 @@ By default, the status logger only reports errors on the standard error stream,
9398
9499
include::partial$properties-status-logger.adoc[leveloffset=+2]
95100
101+
[id=properties-simple-logger]
96102
=== Simple logger
97103
98104
NOTE: To configure simple logger you can also place its configuration in a file named `log4j2.simplelog.properties`.
@@ -101,7 +107,7 @@ The simple logger implementation contained in `log4j-api` can be configured usin
101107
102108
include::partial$properties-simple-logger.adoc[leveloffset=+2]
103109
104-
[#simple-logger-thread-context]
110+
[id=properties-simple-logger-thread-context]
105111
=== Thread context (Simple Logger)
106112
107113
The behavior of the `ThreadContext` class can be fine-tuned using the following properties.
@@ -117,28 +123,33 @@ The `log4j-to-jul` logging bridge ignores all `ThreadContext` method calls.
117123
118124
include::partial$properties-thread-context.adoc[leveloffset=+2]
119125
126+
[id=properties-log4j-core]
120127
== Log4j Core properties
121128
122129
While the only required configuration of the `log4j-core` library is provided by the xref:manual/configuration.adoc[configuration file], the library offers many configuration properties that can be used to finely tune the way it works.
123130
131+
[id=properties-async]
124132
=== Async components
125133
126134
The behavior of all three async components (`AsyncLogger`, `AsyncLoggerConfig` and `AsyncAppender`) can be tuned using these properties:
127135
128136
include::partial$properties-async.adoc[leveloffset=+2]
129137
138+
[id=properties-async-logger]
130139
=== Full asynchronous logger
131140
132141
The `AsyncLogger` component supports the following additional properties:
133142
134143
include::partial$properties-async-logger.adoc[leveloffset=+2]
135144
145+
[id=properties-async-logger-config]
136146
=== Mixed asynchronous logger
137147
138148
The `AsyncLoggerConfig` component supports the following additional properties:
139149
140150
include::partial$properties-async-logger-config.adoc[leveloffset=+2]
141151
152+
[id=properties-properties-context-selector]
142153
=== Context selector
143154
144155
The link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ContextSelector[ContextSelector] component specifies the strategy used by Log4j to create new logger contexts.
@@ -152,6 +163,7 @@ See xref:manual/async.adoc[Async Logging] as an example of this usage.
152163
153164
include::partial$properties-context-selector.adoc[leveloffset=+2]
154165
166+
[id=properties-configuration-factory]
155167
=== Configuration factory
156168
157169
Since configuration factories are used to parse the configuration file, they can **only** be configured through global configuration properties.
@@ -160,25 +172,29 @@ Since configuration factories are used to parse the configuration file, they can
160172
====
161173
Log4j Core supports both local and remote configuration files.
162174
If a remote configuration file is used, its transport must be secured.
163-
See <<transport-security>> for details.
175+
See <<properties-transport-security>> for details.
164176
====
165177
166178
include::partial$properties-configuration-factory.adoc[leveloffset=+2]
167179
180+
[id=properties-garbage-collection]
168181
=== Garbage Collection
169182
170183
include::partial$properties-garbage-collection.adoc[leveloffset=+2]
171184
185+
[id=properties-jansi]
172186
=== JANSI
173187
174188
If the https://fusesource.github.io/jansi/[JANSI] library is on the runtime classpath of the application, the following property can be used to control its usage:
175189
176190
include::partial$properties-jansi.adoc[leveloffset=+2]
177191
192+
[id=properties-jmx]
178193
=== JMX
179194
180195
include::partial$properties-jmx.adoc[leveloffset=+2]
181196
197+
[id=properties-jndi]
182198
=== JNDI
183199
184200
Due to the inherent security problems of https://docs.oracle.com/javase/tutorial/jndi/overview/[JNDI], its usage in Log4j is restricted to the `java:` protocol.
@@ -187,13 +203,13 @@ Moreover, each JNDI usage must be **explicitly** enabled by the user through the
187203
188204
include::partial$properties-jndi.adoc[leveloffset=+2]
189205
190-
[#log4j-core-thread-context]
206+
[id=properties-log4j-core-thread-context]
191207
=== Thread context (Log4j Core)
192208
193209
Log4j Core supports the same properties as Simple Logger for the configuration of the thread context.
194-
See <<simple-logger-thread-context>> for more details.
210+
See <<properties-simple-logger-thread-context>> for more details.
195211
196-
[#transport-security]
212+
[id=properties-transport-security]
197213
=== Transport security
198214
199215
Since configuration files can be used to load arbitrary classes into a Log4j Core `Configuration`, users need to ensure that all the configuration elements come from trusted sources (cf. link:/security#threat-common-config-sources[Thread model] for more information).
@@ -202,25 +218,29 @@ In order to protect the user Log4j disables the `http` URI scheme by default and
202218
203219
include::partial$properties-transport-security.adoc[leveloffset=+2]
204220
221+
[id=properties-log4j-core-misc]
205222
=== Miscellaneous properties
206223
207224
include::partial$properties-log4j-core-misc.adoc[leveloffset=+2]
208225
226+
[id=properties-other-components]
209227
== Other components
210228
229+
[id=properties-log4j-jul]
211230
=== JUL-to-Log4j API bridge properties
212231
213232
The JUL-to-Log4j API bridge provides the following configuration properties:
214233
215234
include::partial$properties-log4j-jul.adoc[leveloffset=+2]
216235
236+
[id=properties-log4j-spring-boot]
217237
=== Log4j Spring Boot properties
218238
219239
The Log4j Spring Boot module supports the following configuration properties:
220240
221241
include::partial$properties-log4j-spring-boot.adoc[leveloffset=+2]
222242
223-
[#property-sources]
243+
[id=property-sources]
224244
== Property sources
225245
226246
The Log4j configuration properties sub-system merges the content of multiple property sources that implement the Java interface link:../javadoc/log4j-api/org/apache/logging/log4j/util/PropertySource[PropertySource].

0 commit comments

Comments
 (0)