[
https://issues.apache.org/jira/browse/LOG4J2-1379?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Remko Popma updated LOG4J2-1379:
--------------------------------
Description:
Documentation for yaml config files
http://logging.apache.org/log4j/2.x/manual/configuration.html
fails to mention that this dependency must be added to actually use yaml config
files:
{code}
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>2.7.4</version>
</dependency>
{code}
It also fails to mention that the equivalent basic config in yaml is the
following:
{code}
Configuration:
status: warn
Appenders:
Console:
name: Console
target: SYSTEM_OUT
PatternLayout:
Pattern: "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
Loggers:
Root:
level: info
AppenderRef:
ref: Console
{code}
At runtime, log4j2 "does not find" the config file (useless and misleading
error message), which in reality means it does not find the needed dependencies.
To actually fix this, one must debug log4j2.
So basically failing to mention something in documentation (effort = 0) causes
users to have to debug log4j (effort >> 0).
This gives the whole project an amateurish and unkempt feel.
was:
Documentation for yaml config files
http://logging.apache.org/log4j/2.x/manual/configuration.html
fails to mention that this dependency must be added to actually use yaml config
files:
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>2.7.4</version>
</dependency>
It also fails to mention that the equivalent basic config in yaml is the
following:
Configuration:
status: warn
Appenders:
Console:
name: Console
target: SYSTEM_OUT
PatternLayout:
Pattern: "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
Loggers:
Root:
level: info
AppenderRef:
ref: Console
At runtime, log4j2 "does not find" the config file (useless and misleading
error message), which in reality means it does not find the needed dependencies.
To actually fix this, one must debug log4j2.
So basically failing to mention something in documentation (effort = 0) causes
users to have to debug log4j (effort >> 0).
This gives the whole project an amateurish and unkempt feel.
I modified the subscription to surround code/config snippets with \{code\}.
> Documentation is subzero quality as far as yaml config files are concerned
> --------------------------------------------------------------------------
>
> Key: LOG4J2-1379
> URL: https://issues.apache.org/jira/browse/LOG4J2-1379
> Project: Log4j 2
> Issue Type: Bug
> Reporter: piero de salvia
>
> Documentation for yaml config files
> http://logging.apache.org/log4j/2.x/manual/configuration.html
> fails to mention that this dependency must be added to actually use yaml
> config files:
> {code}
> <dependency>
> <groupId>com.fasterxml.jackson.dataformat</groupId>
> <artifactId>jackson-dataformat-yaml</artifactId>
> <version>2.7.4</version>
> </dependency>
> {code}
> It also fails to mention that the equivalent basic config in yaml is the
> following:
> {code}
> Configuration:
> status: warn
> Appenders:
> Console:
> name: Console
> target: SYSTEM_OUT
> PatternLayout:
> Pattern: "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
> Loggers:
> Root:
> level: info
> AppenderRef:
> ref: Console
> {code}
> At runtime, log4j2 "does not find" the config file (useless and misleading
> error message), which in reality means it does not find the needed
> dependencies.
> To actually fix this, one must debug log4j2.
> So basically failing to mention something in documentation (effort = 0)
> causes users to have to debug log4j (effort >> 0).
> This gives the whole project an amateurish and unkempt feel.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
