logging-log4j-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ralph Goers (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LOG4J2-1379) Documentation is subzero quality as far as yaml config files are concerned
Date Wed, 04 May 2016 15:40:12 GMT

    [ https://issues.apache.org/jira/browse/LOG4J2-1379?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15270855#comment-15270855

Ralph Goers commented on LOG4J2-1379:

Yeah - we could have done without the "amateurish" comment. Since none of us are paid a dime
to work on Log4j, by definition we aren't professionals. That said, the Log4j 2 PDF manual
is currently 234 pages long. Of course, some things are going to have better documentation
than others.

That said, we should find a way to improve the error message if a yaml (or json) file is provided
but they aren't supported.  But that really should be in a separate Jira issue since this
one seems to be about enhancing the documentation.

> 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:
>         <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.

This message was sent by Atlassian JIRA

To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org

View raw message