Bug 979495

Summary: HornetQ Logging Documentation Missing
Product: [JBoss] JBoss Enterprise Application Platform 6 Reporter: apestel
Component: DocumentationAssignee: Nidhi <nsriniva>
Status: CLOSED CURRENTRELEASE QA Contact: Russell Dickenson <rdickens>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 6.1.0CC: mnovak, msvehla, nobody, nsriniva, smumford
Target Milestone: post-GAKeywords: Documentation, FutureFeature
Target Release: EAP 6.3.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Instance Name: Not Defined Build: CSProcessor Builder Version 1.8 Build Name: 11865, Administration and Configuration Guide-6.1-3 Build Date: 23-05-2013 10:40:22
Last Closed: 2014-11-23 23:16:59 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description apestel 2013-06-28 16:43:27 UTC 
Title:  HornetQ Logging Documentation Missing

Describe the issue:

Documentation for HornetQ logging is not present and/or not sufficient.  In support case 00897472, customer was referred to this community documentation link:

http://docs.jboss.org/hornetq/2.2.14.Final/user-manual/en/html/logging.html


Suggestions for improvement:

Would like to have information that is important enough to send to customers to be in the enterprise documentation, not just the community documentation.


Additional information:
Comment 2 Miroslav Novak 2013-07-01 09:05:10 UTC 
Logging for HornetQ in EAP 6.x must be set in logging subsystem in standalone-full...xml. For example by:
<profile>
         <subsystem xmlns="urn:jboss:domain:logging:1.2">
            <console-handler name="CONSOLE">
                <level name="DEBUG"/>
                <formatter>
                    <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
                </formatter>
            </console-handler>
            <periodic-rotating-file-handler name="FILE">
                <formatter>
                    <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
                </formatter>
                <file relative-to="jboss.server.log.dir" path="server.log"/>
                <suffix value=".yyyy-MM-dd"/>
                <append value="true"/>
            </periodic-rotating-file-handler>
            <logger category="com.arjuna">
                <level name="TRACE"/>
            </logger>
            ...
            <logger category="org.hornetq">
                <level name="INFO"/>
            </logger>

            <!--<logger category="org.jboss.netty">
                <level name="TRACE"/>
            </logger>-->
            ...
            <root-logger>
                <level name="TRACE"/>
                <handlers>
                    <handler name="CONSOLE"/>
                    <handler name="FILE"/>
                </handlers>
            </root-logger>
        </subsystem>
Comment 8 Miroslav Novak 2014-07-22 11:49:23 UTC 
Hi Nidhi,

yes, primary information is that it's needed to add "org.hornetq" category with desired logging level to logging subsystem. This is also possible to add using CLI - we should add reference to Chapter 14. The Logging Subsystem for more details (more precisely  ⁠14.3.2. Configure a Log Category in the CLI)

Thanks,
Mirek
Comment 10 Miroslav Novak 2014-07-24 08:42:55 UTC 
Hi Nidhi,

changes looks ok. I'd just move the chapter to somewhere else, for example to 20.6. Configuration.

There is root logger:
...
<root-logger>
                <level name="INFO"/>
...
which sets default log level for all packages.

Logger category specifies that a "package" (for example "org.hornetq") will be logged on different level (like TRACE, WARN,...) than is default. So logger category actually specifies exceptions to normal root-logger.

Cheers,
Mirek
Comment 13 Miroslav Novak 2014-08-18 11:20:31 UTC 
Thanks Nidhi! Verified.