[
https://issues.apache.org/jira/browse/IGNITE-7611?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708887#comment-16708887
]
Stanislav Lukyanov commented on IGNITE-7611:
--------------------------------------------
On the Logging Configuration Tips section: I would be happy to see it as a
short walkthrough to get a decent logging setup.
Ideally, this should be the first (and only) section that a user reads to setup
logging sufficient to debug issues - either themselves or with the help of
community/experts/etc.
What I imagine there:
- Use log4j framework. Even though log4j2 is more advanced, log4j currently
have some additional support in Ignite (in that Ignite is able to pick it up
more easily without additional configuration).
-- If you use Maven
--- add ignite-log4j dependency
--- add log4j XML configuration file to META-INF/ignite-log4j.xml (you can copy
it from binary distribution)
-- If you use Ignite binary distribution
--- move libs/option/ignite-log4j into libs/
- Review the ignite-log4j.xml file. Uncomment CONSOLE_OUT appender.
- If you don't use Ignite binary distribution make sure to set workDirectory
path
- Start Ignite in verbose mode
-- If you use ignite.sh use -v
-- If you stat Ignite from Java code, set IGNITE_QUIET=false
A walkthrough like this is arguably more important than any other ways we can
document logging. It will solve the issue for 99% of users.
The current draft is fine as is and can be published, but I believe we need to
1) Make sure we have a ticket to document the walkthrough like the one above 2)
Make sure we have a ticket to document the logging options that [~Artem
Budnikov] has described as "difficult to comprehend" - if not in the user docs,
we need to have them documented on dev Wiki or somewhere else, and eventually
either improve so that they're usable or just remove them.
> Document logger configuration options
> -------------------------------------
>
> Key: IGNITE-7611
> URL: https://issues.apache.org/jira/browse/IGNITE-7611
> Project: Ignite
> Issue Type: Bug
> Components: documentation
> Reporter: Stanislav Lukyanov
> Assignee: Stanislav Lukyanov
> Priority: Major
> Fix For: 2.7
>
>
> Existing documentation on readme.io
> (https://apacheignite.readme.io/docs/logging) gives details on how to enable
> each of the supported logging frameworks, and some info on the default
> configuration (e.g. IGNITE_QUIET).
> The documentation should also cover some other features of Ignite logging,
> such as recently added features of automatic reconfiguration of log4j 1.x and
> 2.x (IGNITE-6946) and DEV_ONLY marker in logging messages (IGNITE-7284), as
> well as other features like automatic metrics logging (MetricsLogFrequency)
> and performance suggestions on start
> (IGNITE_PERFORMANCE_SUGGESTIONS_DISABLED).
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
