This is an automated email from the ASF dual-hosted git repository.
rgoers pushed a commit to branch LOG4J2-913
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/LOG4J2-913 by this push:
new 3372e71 More documentation fixes
3372e71 is described below
commit 3372e71b673c31b8258b9f7e34252e3cbab97f57
Author: Ralph Goers <[email protected]>
AuthorDate: Thu Apr 4 21:37:14 2019 -0700
More documentation fixes
---
log4j-docker/src/site/markdown/index.md.vm | 3 +-
.../src/site/markdown/index.md | 2 +-
.../docker/docker-compose.yml | 1 +
.../src/main/config-repo/log4j2.xml | 10 +++----
src/site/markdown/manual/cloud.md | 33 +++++++++++++---------
5 files changed, 29 insertions(+), 20 deletions(-)
diff --git a/log4j-docker/src/site/markdown/index.md.vm
b/log4j-docker/src/site/markdown/index.md.vm
index 42ee2cc..e717fb9 100644
--- a/log4j-docker/src/site/markdown/index.md.vm
+++ b/log4j-docker/src/site/markdown/index.md.vm
@@ -28,7 +28,8 @@ $h2 Accessing Docker
The Log4j Docker support requires access to the Docker REST intrerface. In
practical terms this means the
application either needs access to unix:///var/run/docker.sock through a
volume mount (not recommended),
bind Docker to another host/port or unix socket. or use a proxy application to
provide access. The
-Log4j Spring Cload sample application uses a socat proxy to access Docker.
+[Log4j Spring Cloud sample
application](https://github.com/apache/logging-log4j2/tree/master/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-application)
+uses a socat proxy to access Docker.
$h2 Lookup Attributes
diff --git
a/log4j-spring-cloud-config/log4j-spring-cloud-config-client/src/site/markdown/index.md
b/log4j-spring-cloud-config/log4j-spring-cloud-config-client/src/site/markdown/index.md
index 5530859..a65bd01 100644
---
a/log4j-spring-cloud-config/log4j-spring-cloud-config-client/src/site/markdown/index.md
+++
b/log4j-spring-cloud-config/log4j-spring-cloud-config-client/src/site/markdown/index.md
@@ -18,7 +18,7 @@
# Log4j Spring Cloud Configuration
-This module allows logging configuration files managed in be dynamically
updated when new versions are available in
+This module allows logging configuration files to be dynamically updated when
new versions are available in
Spring Cloud Configuration.
## Overview
diff --git
a/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-application/docker/docker-compose.yml
b/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-application/docker/docker-compose.yml
index 76a0d09..0d76f52 100755
---
a/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-application/docker/docker-compose.yml
+++
b/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-application/docker/docker-compose.yml
@@ -41,6 +41,7 @@ services:
- "24224:24224"
volumes:
- ./init/fluent-bit/fluent-bit.conf:/fluent-bit/etc/fluent-bit.conf
+ - ./target/logs:/var/logs
networks:
sample_network:
aliases:
diff --git
a/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-server/src/main/config-repo/log4j2.xml
b/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-server/src/main/config-repo/log4j2.xml
index 1e5eea6..84b9673 100644
---
a/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-server/src/main/config-repo/log4j2.xml
+++
b/log4j-spring-cloud-config/log4j-spring-cloud-config-samples/log4j-spring-cloud-config-sample-server/src/main/config-repo/log4j2.xml
@@ -3,7 +3,7 @@
<Configuration status="DEBUG" monitorInterval="0">
<Appenders>
<Console name="console" target="SYSTEM_OUT">
- <JsonLayout properties="true" compact="true" eventEol="true">
+ <JsonLayout properties="true" compact="true" eventEol="true"
stackTraceAsString="true">
</JsonLayout>
</Console>
<Flume name="flume" ignoreExceptions="false" type="Embedded"
compress="false">
@@ -24,7 +24,7 @@
</Flume>
<Flume name="avro" ignoreExceptions="false" batchSize="1" compress="false">
<Agent host="flume" port="5050"/>
- <JsonLayout properties="true" compact="true" eventEol="true">
+ <JsonLayout properties="true" compact="true" eventEol="true"
stackTraceAsString="true">
<KeyValuePair key="containerId" value="\${docker:containerId}"/>
<KeyValuePair key="containerName" value="\${docker:containerName}"/>
<KeyValuePair key="imageName" value="\${docker:imageName}"/>
@@ -50,7 +50,7 @@
<Property name="bootstrap.servers">host.docker.internal:9092</Property>
</Kafka>
<Socket name="fluent-bit" host="fluent-bit" port="24221">
- <JsonLayout properties="true" compact="true" eventEol="true">
+ <JsonLayout properties="true" compact="true" eventEol="true"
stackTraceAsString="true">
<KeyValuePair key="containerId" value="\${docker:containerId}"/>
<KeyValuePair key="containerName" value="\${docker:containerName}"/>
<KeyValuePair key="imageName" value="\${docker:imageName}"/>
@@ -58,7 +58,7 @@
</Socket>
<RollingFile name="RollingFile" fileName="/var/log/sampleapp/app.log"
filePattern="/var/log/sampleapp/archive/app.log.%i">
- <JsonLayout properties="true" compact="true" eventEol="true">
+ <JsonLayout properties="true" compact="true" eventEol="true"
stackTraceAsString="true">
<KeyValuePair key="containerId" value="\${docker:containerId}"/>
<KeyValuePair key="containerName" value="\${docker:containerName}"/>
<KeyValuePair key="imageName" value="\${docker:imageName}"/>
@@ -91,7 +91,7 @@
<AppenderRef ref="console"/>
</Logger>
<Root level="DEBUG">
- <AppenderRef ref="Kafka"/>
+ <AppenderRef ref="console"/>
</Root>
</Loggers>
</Configuration>
\ No newline at end of file
diff --git a/src/site/markdown/manual/cloud.md
b/src/site/markdown/manual/cloud.md
index 71a1125..53d78e2 100644
--- a/src/site/markdown/manual/cloud.md
+++ b/src/site/markdown/manual/cloud.md
@@ -20,7 +20,7 @@
## The Twelve-Factor Application
-The Logging Guidelines for [The Twelve-Factor App](https://12factor.net/logs)
state the all logs should be routed
+The Logging Guidelines for [The Twelve-Factor App](https://12factor.net/logs)
state that all logs should be routed
unbuffered to stdout. Since this is the least common denominator it is
guaranteed to work for all applications. Howeever,
as with any set of general guidelines, choosing the least common denominator
approach comes at a cost. Some of the costs
in Java applications include:
@@ -42,7 +42,7 @@ only when it has placed the event in durable storage, such as
what Apache Flume
All the solutions discussed on this page are predicated with the idea that log
files cannot permanently
reside on the file system and that all log events should be routed to one or
more log analysis tools that will
-be used for reporting and alreting. There are many ways to forward and collect
events to be sent to the
+be used for reporting and alerting. There are many ways to forward and collect
events to be sent to the
log analysis tools.
Note that any approach that bypasses Docker's logging drivers requires Log4j's
@@ -94,11 +94,15 @@ host and port be configured on a SocketAppender with an
appropriate layout.
### Sending Directly to a Log Aggregator via TCP
Similar to sending logs to a forwarder, logs can also be sent to a cluster of
aggregators. However,
-setting this up is not as simple. Since, to be highly available, a cluster of
aggregators must be used.
+setting this up is not as simple since, to be highly available, a cluster of
aggregators must be used.
However, the SocketAppender currently can only be configured with a single
host and port. To allow
for failover if the primary aggregator fails the SocketAppender must be
enclosed in a
[FailoverAppender](appenders.html#FailoverAppender),
-which would also have the secondary aggregator configured.
+which would also have the secondary aggregator configured. Another option is
to have the SocketAppender
+point to a highly available proxy that can forward to the Log Aggregator.
+
+If the log aggregator used is Apache Flume or Apache Kafka (or similar) the
Appenders for these support
+being configured with a list of hosts and ports so high availability is not an
issue.
@@ -114,7 +118,7 @@ all log events for a specific user or customer to
temporarily be logged
Also, in a micro-services, clustered environment it is quite likely that these
changes will need to be propagated
to multiple servers at the same time. Trying to achieve this via REST calls
could be difficult.
-Log4j supports dynamic reconfiguration. since the first release Log4j has
supported reconfiguration through a file.
+Since its first release Log4j has supported reconfiguration through a file.
Beginning with Log4j 2.12.0 Log4j also supports accessing the configuration
via HTTP(S) and monitoring the file
for changes by using the HTTP "If-Modified-Since" header. A patch has also
been integrated into Spring Cloud Config
starting with versions 2.0.3 and 2.1.1 for it to honor the If-Modified-Since
header. In addition, the
@@ -129,7 +133,7 @@ While the standard Spring Boot REST endpoints to update
logging will still work
REST endpoints will be lost if Log4j reconfigures itself do to changes in the
logging configuration file.
Further information regarding integration of the
log4j-spring-cloud-config-client can be found at
-[Log4j Spring Cloud Config
Client](../log4j-spring-cloud-config/log4j-spring-cloud-config-client/index.html)
+[Log4j Spring Cloud Config
Client](../log4j-spring-cloud-config/log4j-spring-cloud-config-client/index.html).
## Integration with Docker
@@ -140,13 +144,16 @@ provides similar functionality via the [Docker
Loookup](lookups.html#DockerLooku
Log4j's Docker support may also be found at
[Log4j-Docker](../log4j-docker/index.html).
## Appender Performance
-The numbers in the table below represent how much time was required for the
application to call logger.debug
-100,000 times. These numbers only include the time taken to deliver to the
specifcly noted endpoint and
-many not include the actual time required before they are availble for
viewing. All measurements were
-performed on a MacBook Pro with a 2.9GHz Intel Core I9 processor with 6
physical and 12 logical cores,
-32GB of 2400 MHz DDR4 RAM, and 1TB of Apple SSD storage. The VM used by Docker
was managed by VMWare Fusion
-and had 4 CPUs and 2 GB of RAM. These number should be used for relative
perfomance comparisons as the
-results on another system may vary considerably.
+The numbers in the table below represent how much time in seceonds was
required for the application to
+call logger.debug 100,000 times. These numbers only include the time taken to
deliver to the specifcly
+noted endpoint and many not include the actual time required before they are
availble for viewing. All
+measurements were performed on a MacBook Pro with a 2.9GHz Intel Core I9
processor with 6 physical and 12
+logical cores, 32GB of 2400 MHz DDR4 RAM, and 1TB of Apple SSD storage. The VM
used by Docker was managed
+by VMWare Fusion and had 4 CPUs and 2 GB of RAM. These number should be used
for relative perfomance comparisons
+as the results on another system may vary considerably.
+
+The sample application used can be found under the
log4j-spring-cloud-config/log4j-spring-cloud-config-samples
+directory in the Log4j [source
repository](https://github.com/apache/logging-log4j2).
| Test | 1 Thread | 2 Threads | 4 Threads | 8 Threads |
|------------------------ |---------:|----------:|----------:|----------:|
