7 Administering the Logging Service

Log File Names and Locations

In an Oracle GlassFish Server domain, log files have the following names and locations by default:

For example, in a domain hosted on a given machine that includes a cluster with two managed servers (ClusterServer1 and ClusterServer1) and a standalone instance (StandaloneServer), the log files might be arranged in the following directory structure. In this directory structure, the server.log file for the DAS is located in domain-dir/logs.

as-install-parent directory
     glassfish/
         domains/
             domain-dir/
                         logs/
                            server.log
         nodes/
             hostname/
                         ClusterServer1/
                                      logs/
                                         server.log
                                         cluster.log
                         ClusterServer2/
                                      logs/
                                         server.log
                                         cluster.log
                         StandaloneServer/
                                      logs/
                                         server.log

You can change the default name or location of a log file by modifying the logging properties file for the corresponding instance, described in To Change the Name and Location of the Log File.

Log Records

Oracle GlassFish Server log records follow a uniform format:

[#|yyyy-mm-ddThh:mm:ss.SSS-Z|Log Level|ProductName-Version|LoggerName|Key Value Pairs|Message|#]

• [# and #] mark the beginning and end of the record.

• The vertical bar (|) separates the fields of the record.

• yyyy-mm-ddThh:mm:ss.SSSS-Z represents the date and time that the record was created. For example: 2006-10-21T13:25:53.852-0400

• Log Level represents the log level. You can set any of the following values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, and FINEST. The default is INFO.

• ProductName-Version represents the current version of the Oracle GlassFish Server. For example: glassfish

• LoggerName represents a hierarchical logger namespace that identifies the source of the log module. For example: javax.enterprise.system.core

• Key Value Pairs represents pairs of key names and values, typically a thread ID. For example: _ThreadID=14;

• Message represents the text of the log message. For all Oracle GlassFish Server SEVERE and WARNING messages and for many INFO messages, the message begins with a message ID that consists of a module code and a numerical value. For example: CORE5004

The following is an example of a log record:

[#|2006-10-21T13:25:53.852-0400|INFO|GlassFish10.0|javax.enterprise.
system.core|_ThreadID=13;|CORE5004: Resource Deployed: 
[cr:jms/DurableConnectionFactory].|#]

The Administration Console presents log records in a more readable display.

Log Rotation

By default, when a log file grows to 2 MB, Oracle GlassFish Server renames (rotates) the file to incorporate a timestamp and creates a new log file. The log file is renamed as log-type.log_date, where log-type represents either server or cluster, and date represents the time of rotation.

You can configure the logging service to change the default settings for log file rotation, as explained in Setting Log File Rotation.

To Change the Name and Location of the Log File

To change the name and location of the log file, first use the list-log-attributes subcommand to obtain the current log attribute setting for the log file name and location. Then use the set-log-attributes subcommand to specify the new name or location. The default target for these two subcommands is the DAS. However, you can optionally specify one of the following targets:

• Configuration name — to target all instances or clusters that share a specific configuration name.

• Server name — to target only a specific server.

• Instance name — to target only a specific instance.

• Cluster name — to target only a specific cluster.

1. Ensure that the target server or cluster is running.

   Remote subcommands require a running server.

2. Use the list-log-attributes subcommand in remote mode to obtain the current log attribute settings.

   The name and location of the log file is set with the com.sun.enterprise.server.logging.GFFileHandler.file attribute of the logging properties file. Optionally you can target a configuration, server, instance, or cluster. If you do not specify a target, the log attribute settings for the DAS are displayed.

3. Use the set-log-attributes subcommand in remote mode to define a custom name or location of the log file.

   If you do not specify a target, the log file for the DAS is targeted by default. If you target a cluster, the name of the cluster log file for each member instance can be changed (the server log file name cannot).

asadmin> list-log-attributes Cluster1
com.sun.enterprise.server.logging.GFFileHandler.alarms <false>
com.sun.enterprise.server.logging.GFFileHandler.file 
<${com.sun.aas.instanceRoot}/logs/server.log>
com.sun.enterprise.server.logging.GFFileHandler.flushFrequency  <1>
.
.
.
log4j.logger.org.hibernate.validator.util.Version <warn>
Command list-log-attributes executed successfully.
asadmin> set-log-attributes --target Cluster1
com.sun.enterprise.server.logging.GFFileHandler.file=
${com.sun.aas.instanceRoot}/logs/cluster1.log
com.sun.enterprise.server.logging.GFFileHandler.file
logging attribute set with value ${com.sun.aas.instanceRoot}/logs/cluster1.log
These logging attributes are set for Cluster1.
ClusterServer1 :
com.sun.enterprise.server.logging.GFFileHandler.file
logging attribute set with value ${com.sun.aas.instanceRoot}/logs/cluster1.log
These logging attributes are set for Cluster1.

ClusterServer2 :
com.sun.enterprise.server.logging.GFFileHandler.file
logging attribute set with value ${com.sun.aas.instanceRoot}/logs/cluster1.log
These logging attributes are set for Cluster1.

Command set-log-attributes executed successfully.

See Also

You can view the full syntax and options of these subcommands by typing asadmin help list-log-levels and asadmin help set-log-attributes at the command line.

To Change the Name and Location of the Logging Properties File

You can set the name and location of the logging properties file by setting the java.util.logging.config.file system property. By setting this system property, you can have a single logging properties file that is used by all instances running on the same host.

1. Set the java.util.logging.config.file system property.

   For example, you can use the following java command:

   java -Djava.util.logging.config.file=properties_file
   

   Alternatively, you can use the Administration Console to set this system property.

2. To apply your change, restart Oracle GlassFish Server.

java -Djava.util.logging.config.file=/space/mylogging/logging.properties

To List Log Levels

Oracle GlassFish Server provides the means to list all loggers and their log levels. Listing the loggers provides a convenient means to view current loggers and log levels either prior to or after making log level changes.

Use the list-log-levels subcommand in remote mode to list the modules and their current log levels. The default target for this subcommand is the DAS. However, you can optionally specify one of the following targets:

• Configuration name — to target all instances or clusters that share a specific configuration name.

• Server name — to target a specific server.

• Instance name — to target a specific instance.

• Cluster name — to target a specific cluster.

1. Ensure that the DAS is running.

   Remote subcommands require a running server.

2. List the existing module loggers and log levels by using the list-log-levels subcommand.

asadmin> list-log-levels 
javax.enterprise.system.container.cmp <INFO>
javax.enterprise.system.tools.admin <INFO>
java.util.logging.ConsoleHandler <FINEST>
javax.enterprise.system.container.web <INFO>
javax.enterprise.system.util <INFO>
javax.enterprise.resource.webcontainer.jsf.timing <INFO>
javax <INFO>
javax.enterprise.resource.corba <INFO>
...
Command list-log-levels executed successfully.

asadmin> list-log-levels MyServer2
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>
...
Command list-log-levels executed successfully.

See Also

You can view the full syntax and options of the subcommand by typing asadmin help list-log-levels at the command line.

To Set the Global Log Level

The global log level specifies the events that are logged across all loggers. The default level for messages output to the console is INFO (which also includes SEVERE and WARNING messages).

Use the set-log-levels subcommand in remote mode to set the global log level. The default target for this subcommand is the DAS. However, you can optionally specify one of the following targets using the --target option:

• Configuration name — to target all instances or clusters that share a specific configuration name.

• Server name — to target a specific server.

• Instance name — to target a specific instance.

• Cluster name — to target a specific cluster.

1. Ensure that the target server or cluster is running.

2. Set the global log level by using the set-log-levels subcommand, specifying the log level of the java.util.logging.ConsoleHandler logger.

   The ConsoleHandler has a separate log level setting that limits the messages that are displayed. For example:

   java.util.logging.ConsoleHandler <FINEST>
   

asadmin> set-log-levels java.util.logging.ConsoleHandler=INFO
java.util.logging.ConsoleHandler package set with log level INFO.
These logging levels are set for server.

Command set-log-levels executed successfully.

See Also

You can view the full syntax and options of the subcommand by typing asadmin help set-log-levels at the command line.

To Set Module Log Levels

A module log level specifies the events that are logged for a particular logger. The default level for messages output to the console is INFO (which also includes SEVERE and WARNING messages). The global log level is overridden by a module-specific log level.

By default, the module log level is set to FINE. The lines for the loggers in the logging properties file might look like this (the modules are indicated in bold):

javax.enterprise.system.tools.level=FINE
javax.enterprise.system.container.ejb.level=FINE
javax.enterprise.system.core.security.level=FINE
javax.enterprise.system.tools.admin.level=FINE
javax.enterprise.level=FINE
javax.enterprise.system.container.web.level=FINE

Because setting log levels is a dynamic operation, you do not need to restart Oracle GlassFish Server for changes to take effect.

1. Ensure that the target server or cluster is running.

   Remote subcommands require a running server.

2. List the existing module loggers and their log levels by using the list-log-levels subcommand.

3. Set the log level for a module by using the set-log-levels subcommand.

   Your choices are SEVERE, WARNING, INFO, CONFIG, FINE, FINER, and FINEST.

asadmin> set-log-levels --target ManagedServer1
javax.enterprise.system.container.web=WARNING
javax.enterprise.system.container.web package set with log level WARNING.
These logging levels are set for ManagedServer1.
ManagedServer1 :
javax.enterprise.system.container.web package set with log level WARNING.
These logging levels are set for ManagedServer1.

Command set-log-levels executed successfully.

asadmin> set-log-levels javax.enterprise.system.core.security=FINE:
javax.enterprise.system.container.web=WARNING
javax.enterprise.system.container.web package set with log level WARNING.
javax.enterprise.system.core.security package set with log level FINE.
These logging levels are set for server.

Command set-log-levels executed successfully.

See Also

You can view the full syntax and options of the subcommand by typing asadmin help set-log-levels at the command line.

To Change the Rotation File Size

Use the set-log-attributes subcommand in remote mode to change the log rotation file size. The default target of this subcommand is the DAS. Optionally, you can target a configuration, server, instance, or cluster. The minimum size that can be set is 500 KB.

1. Ensure that the target server or cluster is running.

2. Change the rotation file size limit by using the set-log-attributes subcommand, specifying the following attribute and the desired limit in bytes:

   com.sun.enterprise.server.logging.GFFileHandler.rotationLimitInBytes=bytes
   

3. To apply your change, restart Oracle GlassFish Server.

asadmin> set-log-attributes --target ManagedServer1
com.sun.enterprise.server.logging.GFFileHandler.rotationLimitInBytes=1000000
com.sun.enterprise.server.logging.GFFileHandler.rotationLimitInBytes
logging attribute set with value 1000000.
These logging attributes are set for ManagedServer1.
ManagedServer1 :
com.sun.enterprise.server.logging.GFFileHandler.rotationLimitInBytes 
logging attribute set with value 1000000.
These logging attributes are set for ManagedServer1.

Command set-log-attributes executed successfully.

See Also

You can view the full syntax and options of the subcommand by typing asadmin help set-log-attributes at the command line.

To Change the File Rotation Interval

Use the set-log-attributes subcommand in remote mode to change the log file rotation time limit interval. The default target of this subcommand is the DAS. Optionally, you can target a configuration, server, instance, or cluster. The default value is 0.

1. Ensure that the target server or cluster is running.

2. Change the rotation time limit by using the set-log-attributes subcommand, specifying the following attribute and the desired limit in minutes:

   com.sun.enterprise.server.logging.GFFileHandler.rotationTimelimitInMinutes=minutes
   

3. To apply your change, restart Oracle GlassFish Server.

asadmin> set-log-attributes --target Cluster1
com.sun.enterprise.server.logging.GFFileHandler.rotationTimelimitInMinutes=10
com.sun.enterprise.server.logging.GFFileHandler.rotationTimelimitInMinutes
logging attribute set with value 10.
These logging attributes are set for Cluster1.
ClusterServer1 :
com.sun.enterprise.server.logging.GFFileHandler.rotationTimelimitInMinutes 
logging attribute set with value 10.
These logging attributes are set for Cluster1.

ClusterServer2 :
com.sun.enterprise.server.logging.GFFileHandler.rotationTimelimitInMinutes 
logging attribute set with value 10.
These logging attributes are set for Cluster1.

Command set-log-attributes executed successfully.

See Also

You can view the full syntax and options of the subcommand by typing asadmin help set-log-attributes at the command line.

To Change the Limit Number of Retained Files

Use the set-log-attributes subcommand in remote mode to change the limit on the number of log files that the server creates to store old log messages. The default target of this subcommand is the DAS. Optionally, you can target a configuration, server, instance, or cluster. The default limit value is 0, which results in no limit placed on the number of rotated log files that are retained.

1. Ensure that the target server or cluster is running.

2. Change the limit number of retained log files by using the set-log-attributes subcommand, specifying the following attribute and the desired file limit number:

   com.sun.enterprise.server.logging.GFFileHandler.maxHistoryFiles=minutes
   

   The behavior of the com.sun.enterprise.server.logging.GFFileHandler.maxHistoryFiles attribute is as follows:

   • If the property is not set, Oracle GlassFish Server keeps a maximum of 10 rotated log files.

   • If the property is set to an invalid number or null, Oracle GlassFish Server keeps a maximum of 10 rotated log files.

   • If the property is set to 0, Oracle GlassFish Server retains all rotated log files (that is, no sets no maximum).

3. To apply your change, restart Oracle GlassFish Server.

asadmin> set-log-attributes
com.sun.enterprise.server.logging.GFFileHandler.maxHistoryFiles=10
com.sun.enterprise.server.logging.GFFileHandler.maxHistoryFiles 
logging attribute set with value 10.
These logging attributes are set for server.
Command set-log-attributes executed successfully.

See Also

You can view the full syntax and options of the subcommand by typing asadmin help set-log-attributes at the command line.

To Rotate Log Files Manually

You can rotate log files manually by using the rotate-log subcommand in remote mode. The default target of this subcommand is the DAS. Optionally, you can target a configuration, server, instance, or cluster. When you use this subcommand, the target log file is immediately moved to a new time-stamped file and a new log file is created.

Because log rotation is a dynamic operation, you do not need to restart Oracle GlassFish Server for changes to take effect.

1. Ensure that the target server or cluster is running.

2. Rotate log files by using the rotate-log subcommand.

asadmin> rotate-log --target ManagedServer2
Command rotate-log executed successfully.

See Also

You can view the full syntax and options of the subcommand by typing asadmin help rotate-log at the command line.

To Add a Custom Log Handler

A comma-separated list of log handlers is installed during startup of the Java Virtual Machine (JVM) host. The default log handler that is provided in the logging.properties file, ConsoleHandler, is configured as follows:

handlers=java.util.logging.ConsoleHandler

In Oracle GlassFish Server, the best approach to developing a custom handler is to define a Hundred-Kilobyte Kernel (HK2) component that implements the handler contract. Oracle GlassFish Server registers this handler automatically because it is an HK2 component. There is no task required of the administrator.

To configure a custom handler that is not developed as an HK2 component, add the new handler to the logging.properties file after the developer has put the custom handler JAR file into the domain-dir/lib/ext directory.

Before You Begin

If you set a handler by setting the handlers attribute in the logging properties file, the class that extends java.util.logging.Handler must be in the server classpath.

1. Ensure that the target server or cluster is running.

   Remote subcommands require a running server.

2. Use the set-log-attributes subcommand to add the handler to the handlers attribute.

   The default target of this subcommand is the DAS. Optionally you can target a configuration, server, instance, or cluster.

3. To apply your changes, restart Oracle GlassFish Server.

   See To Restart a Domain.

asadmin> set-log-attributes
handlers=java.util.logging.ConsoleHandler,com.example.logging.MyHandler
handlers logging attribute set with value
java.util.logging.ConsoleHandler,com.example.logging.MyHandler.
These logging attributes are set for server.
Command set-log-attributes executed successfully.

See Also

You can view the full syntax and options of the subcommand by typing asadmin help set-log-attributes at the command line.