GlassFish - World's first Java EE 7 Application Server


Logging Documentation Reviews for GlassFish Server Open Source Edition 3.1

Use this page to provide review comments on the Logging documentation deliverables for GlassFish Server Open Source Edition 3.1. These deliverables are based on the Logging Documentation Plan.

Each of the documentation deliverables is attached to this page in PDF format. A list of links to the PDFs for a specific deliverable set is provided in the review section for that deliverable. For example, the PDFs for the logging asadmin man pages are provided in the New and Revised Man Pages review section. PDFs are added or updated as review drafts become available and comments are incorporated.

Please provide your feedback by adding a comment to this page. To simplify the processing of your comments, please add your comments in the format in the sample comment. Review existing comments to see known issues and avoid duplicates.

Changes to Books

Administration Guide Changes

Section Documentation Impact Reviewers
Status
Chapter 7, Administering the Logging Service Revised
Naman Mehta,
Anissa Lam,
Vince Kraemer,
Jerome Dochez
Review comments incorporated
Appendix A, Section Logging and Monitoring Subcommands Minor revisions to identify new and renamed asadmin subcommands for logging

Complete

Troubleshooting Guide Changes

Section Documentation Impact
Reviewer Status
Examining Log Files in Chapter 1 Minor revisions to call out targeting capability
Anissa Lam
95% complete

Error Message Reference

Section Documentation Impact
Reviewer Status
Error Message Reference Revised for GlassFish 3.1
 All reviewers
Entire book is generated from properties files.

New and Revised Man Pages

Comments are now closed for man pages.

Man Page Name and Section Documentation Impact
Reviewers
Status
collect-log-files New Naman, Anissa
Review comments incorporated
list-log-attributes New Naman, Anissa Review comments incorporated
list-log-levels Minor Naman, Anissa Review comments incorporated
rotate-log Minor Naman, Anissa Review comments incorporated
set-log-attributes New Naman, Anissa Review comments incorporated
set-log-levels Minor Naman, Anissa Review comments incorporated

Related Information

Email aliases:


Attachments:
SJSASEEAG-asadmin-logging-OSE.pdf (application/x-download)
SJSASEETSG-ExaminingLogFiles-OSE.pdf (application/x-download)
list-log-attributes.1.pdf (application/octet-stream)
collect-log-files.1.pdf (application/octet-stream)
list-log-levels.1.pdf (application/octet-stream)
rotate-log.1.pdf (application/octet-stream)
set-log-attributes.1.pdf (application/octet-stream)
set-log-levels.1.pdf (application/octet-stream)
SJSASEEAG-Chap7Logging-OSE.pdf (application/x-download)
GF31_ErrMsgRef.pdf (application/x-download)

Comments:
Comment ID Location Comment
JEP-001 Chapter 7 of Administration Guide, Section "Log File Names and Locations" Sample comment. Please provide suggested fix.
Posted by jonpatt at Jan 23, 2011 09:44

I looked at all commands and my comments are as below:

1. collect-log-files - this command man page needs major change. Please use my blog for the same (http://blogs.oracle.com/naman/entry/analyze_server_logs_in_glassfish)

2. list-log-attributes - pdf is not opening so not yet reviewed.

3. list-log-levels -

Usage: asadmin asadmin-utility-options list-log-levels
[?|-help[]] target

Also, command output format is changed.
E.g.
java.util.logging.ConsoleHandler <FINEST>
javax.enterprise.resource.corba <INFO>
javax.enterprise.resource.javamail <INFO>
javax.enterprise.resource.jdo <INFO>
javax.enterprise.resource.jms <INFO>
javax.enterprise.resource.jta <INFO>
javax.enterprise.resource.resourceadapter <INFO>
javax.enterprise.resource.sqltrace <FINE>
javax.enterprise.resource.webcontainer.jsf.application <INFO>
javax.enterprise.resource.webcontainer.jsf.config <INFO>
javax.enterprise.resource.webcontainer.jsf.context <INFO>
javax.enterprise.resource.webcontainer.jsf.facelets <INFO>

4. rotate-log -

Usage: asadmin asadmin-utility-options rotate-log [\--target <target>|]
[?|-help[]]

5. set-log-attributes - pdf is not opening so not yet reviewed.

6. set-log-levels - looks fine to me. But in target section need following details.

server_name- Default target is server. If no target is specified then it updates log levels for server
cluster_name- The name of a target cluster.
instance_name- The name of a target server instance.

------------------------------------------------------------------------------------------------------------------------------------------

For, list-log-attributes and set-log-attributes are similar to list-log-levels and set-log-levels. Only difference is server restart is required if any change in attributes.

In genral, for all man pages remove display-error-distribution(1), display-error-statistics(1),display-log-records(1) from See Also section and add other commands which were missing there.
Posted by namanmehta at Feb 09, 2011 22:16

One more change needed during review of Chapter - 7. I found the same in this week only when I tried myself.

Page 16.
To implement a new handler that is not developed as an HK2 component, add the new handler
to the logging.properties file after the developer has put the new handler JAR file into the
GF_HOME/glassfish/domains/domain1/lib/ext directory.

My blog: http://blogs.oracle.com/naman/entry/configure_my_custom_log_handler
Posted by namanmehta at Feb 09, 2011 22:17

Updated all man pages per Naman's comments.
Posted by sfordin at Feb 12, 2011 11:04

man pages looks fine to me now. but still chapter 7 review changes need to incorporated.
Posted by namanmehta at Feb 13, 2011 21:21

The latest version of Chapter 7, which includes Naman's comments, is attached.
Posted by jonpatt at Feb 14, 2011 05:40

I verified the same and looks fine to me. No more comment from my side.
Posted by namanmehta at Feb 16, 2011 21:37