Summary: GigaSpaces logging system.
Overview
You can create your own configuration file by specifying a file name with the java.util.logging.config.file system property.
For example:
java -Djava.util.logging.config.file=myfile
When defining a configuration file of your own, the GigaSpaces logging utility is also loaded. Even though both files are loaded, your file does not affect or interrupt the GigaSpaces logging configuration file.
If you do not define any system property, the GigaSpaces logging configuration file is loaded by default.
You can disable the GigaSpaces logging configuration file using the com.gs.logging.disabled system property, though this is not recommended, since you might lose part of the GigaSpaces logging. If com.gs.logging.disabled is set, the system uses the default Java logging settings which are loaded with the JVM:
-Dcom.gs.logging.disabled=true
For GigaSpaces logger loader troubleshooting mode (shows which java logging properties file is loaded and from which location), set:
-Dcom.gs.logging.debug=true
The GigaSpaces logging configuration file can be found under: <GigaSpaces Root>\config\gs_logging.properties.
Changed in GigaSpaces 6.0
GigaSpaces logging infrastructure has been changed in GigaSpaces 6.0. For more details, refer to the migration section. |
Global Properties
You can set any of the gs_logging.properties using a system property. For example, if you want to have a separate logger file-handler URL for each process, set:
The same is true for all other properties, like patterns, log levels, etc.
The classes below must be on the system classpath.
By default, the ConsoleHandler's level is set to ALL, meaning it shows all messages.
| Property |
Default Value |
Description |
| handlers |
java.util.logging.ConsoleHandler, java.util.logging.FileHandler. |
Handlers specifies a comma separated list of log Handler classes. These handlers will be installed during VM startup. |
Default Global Logging Level
This attribute is ignored by GigaSpaces logging utility.
useParentHandlers is always set to false, to avoid the use of parent logger handlers.
| Property |
Default Value |
Description |
| .level |
INFO |
This property specifies which kinds of events are logged across all loggers.
For any given facility, this global level can be overridden by a facilities specific level.
Note that the ConsoleHandler also has a separate level setting to limit messages printed to the console. |
FileHandler Properties
| Property |
Default Value |
Description |
| java.util.logging.FileHandler.level |
ALL |
Specifies the default level for the Handler (default to Level.ALL). |
| java.util.logging.FileHandler.filter |
no Filter |
Specifies the name of a Filter class to use (default to no Filter). |
| java.util.logging.FileHandler.formatter |
com.gigaspaces.logger.GSSimpleFormatter. |
Specifies the name of a Formatter class to use (default to java.util.logging.XMLFormatter). |
| java.util.logging.FileHandler.encoding |
|
The name of the character set encoding to use (default to the default platform encoding). |
| java.util.logging.FileHandler.limit |
2000000 |
Specifies an approximate maximum amount to write (in bytes) to any one file.
If this is zero, then there is no limit (default to no limit). |
| java.util.logging.FileHandler.count |
3 |
Specifies how many output files to cycle through (default to 1). |
| java.util.logging.FileHandler.append |
true |
Specifies whether the FileHandler should append onto any existing files (default to false). |
| java.util.logging.FileHandler.pattern |
../logs/gigaspaces%g_%u.log |
Specifies a pattern for generating the output file name. See details below.
(default to "../logs/gigaspaces%g_%u.log" - <GigaSpaces ROOT>/logs folder or ../logs/gigaspaces_ui_%g_%u.log for the UI application logger).
- "/" - the local pathname separator.
- "%t" - the system's temporary directory.
- "%h"-- the value of the user.home system property.
- "%g" - the generation number to distinguish rotated logs.
- "%u" - a unique number to resolve conflicts.
- "%%" - translates to a single percent sign "%".
|
ConsoleHandler Properties
| Property |
Default Value |
Description |
| java.util.logging.ConsoleHandler.level |
ALL |
Using the ALL level will print all output to console, use it for debugging and troubleshooting. java.util .logging.ConsoleHandler.level = OFF will disable logging into the console. |
| java.util.logging.ConsoleHandler.filter |
no Filter |
Specifies the name of a Filter class to use (default to no Filter). |
| java.util.logging.ConsoleHandler.formatter |
com.gigaspaces.logger .GSSimpleFormatter |
Specifies the name of a Formatter class to use (default to java.util.logging.SimpleFormatter). |
| java.util.logging.ConsoleHandler.encoding |
|
The name of the character set encoding to use (default to the default platform encoding). |
Log Messages Formatting
The com.gigaspaces.logger.GSSimpleFormatter class is used to format messages. This class uses serial numbers, where each number represents a different argument that contains certain data, as seen below:
- 0 – date object.
- 1 – class name if available, logger name otherwise.
- 2 – method name if available, null otherwise.
- 3 – log level.
- 4 – logger name.
- 5 – message.
Default value is:
Example of a full-format:
For more details on formatting, see the
MessageFormat
class.
| Property |
Default Value |
Description |
| com.gigaspaces.logger.GSSimpleFormatter.format |
{0,date} {0,time}\n{3} [{4}]: {5}\n |
The message format. |
When the log component is set to FINER, then GSSimpleFormatter uses a full-format and ignores the supplied (or default) format.
GigaSpaces Loggers
The following properties provide extra control for each logger.
ADMINISTRATIVE
Exception handling:
com.gigaspaces.exceptions.level = SEVERE
When the log message's level is SEVERE, the Exception's stack-trace is logged. At lower levels, only their toString() is logged. To trigger Exception's stack-trace for messages logged with Level.WARNING, set the com.gigaspaces.exceptions.level to WARNING.
MANAGEMENT
GUI, Browser, Cluster View, JMX logging properties:
| Property |
Default Value |
Description |
| com.gigaspaces.admin.level |
INFO |
Space administrations operations. |
| com.gigaspaces.admin.ui.level |
INFO |
GigaSpaces Management Center - ServiceGrid view operations. |
| com.gigaspaces.admin.ui.cluster.view.level |
INFO |
GigaSpaces Management Center - Space cluster view operations. |
| com.gigaspaces.admin.ui.spacebrowser.level |
INFO |
GigaSpaces Management Center - Space view operations. |
| com.gigaspaces.admin.cli.level |
INFO |
Command line utilities operations. |
| org.springmodules.javaspaces.gigaspaces.SpringTracer.level |
INFO |
SpringModules-GigaSpaces tracer. |
| com.gigaspaces.jca.level |
INFO |
J2EE JCA operations. |
| com.gigaspaces.ui.cluster.view.level |
INFO |
Space browser cluster viewer operations. |
| com.gigaspaces.ui.spacebrowser.level |
INFO |
Space browser operations. |
| com.gigaspaces.jmx.level |
INFO |
Space JMX operations. |
SERVER
| Property |
Default Value |
Description |
| com.gigaspaces.core.xa.level |
INFO |
Space XA transaction operations. |
| com.gigaspaces.cache.level |
INFO |
Space cache operations. |
| com.gigaspaces.filters.level |
INFO |
Space filters operations. |
| com.gigaspaces.lrmi.level |
INFO |
Network protocol operations. Set to FINEST for NIO various settings |
| com.gigaspaces.jca.level |
INFO |
J2EE JCA operations. |
| com.gigaspaces.persistent.level |
INFO |
Persistency operations. |
| com.gigaspaces.query.level |
INFO |
JDBC & SQLQuery operations. |
| com.gigaspaces.jms.level |
INFO |
GigaSpaces JMS implementation operations. |
| com.gigaspaces.kernel.level |
INFO |
Space kernel operations. Set to FINE/FINEST to troubleshoot resources loading and ClassLoading issues. |
| com.gigaspaces.worker.multicast.level |
INFO |
Multicast worker operations. |
| com.gigaspaces.spring.level |
INFO |
Space POJO operations |
| com.gigaspaces.pojo.level |
INFO |
POJO conversion using gs.xml and annotations operations. Set to FINEST to troubleshoot gs.xml load. |
| com.gigaspaces.container.level |
INFO |
Space container operations. com.gigaspaces.container.level = CONFIG prints the full cluster policies runtime configuration information. |
| com.gigaspaces.core.common.level |
INFO |
Space and cluster configuration operations. Setting this property to ALL when using POJOs is very useful. Used for security operations as well |
| com.gigaspaces.core.config.level |
CONFIG |
Space configuration operations |
| com.gigaspaces.core.engine.level |
INFO |
Space engine core operations |
| com.gigaspaces.core.lease.level |
INFO |
Lease operations. |
| com.gigaspaces.core.lookupmanager.level |
INFO |
Lookup manager operations. RMIRegistry space/container binding. |
| com.gigaspaces.core.memorymanager.level |
INFO |
Memory manger operations. |
| com.gigaspaces.core.notify.level |
INFO |
Notifications/SessionEvent operations. |
| com.gigaspaces.core.fifo.level |
INFO |
Fifo operations. |
| com.gigaspaces.core.cluster.replication.level |
INFO |
General replication operations. |
| com.gigaspaces.core.cluster.partition.level |
INFO |
Partitioned space operations. |
| com.gigaspaces.core.cluster.sync_replication.level |
INFO |
Synchronous replication. |
| com.gigaspaces.core.cluster.dynamic.level |
INFO |
Dynamic clustering operations. |
| com.gigaspaces.core.cluster.active_election.level |
INFO |
Active Election operations. Useful for primary backup and FO troubleshooting. |
| com.gigaspaces.core.cluster.active_election.infra.level |
INFO |
Active Election infrastructure. Useful for primary backup and FO troubleshooting. |
| com.gigaspaces.externaldatasource.dotnet.level |
INFO |
.Net External Data Source Adapter. |
CLIENT
Client side logging properties:
| Property |
Default Value |
Description |
| com.gigaspaces.client.level |
INFO |
Client space proxy, DCache operations. |
| com.gigaspaces.client.cluster.liveness.level |
INFO |
Allows you to view the status of clustered spaces using different logging level. For more details, see Viewing Clustered Space Status. |
COMMON
Logging properties of common components which vary often used for troubleshooting and produces allot of output:
| Property |
Default Value |
Description |
| com.gigaspaces.common.spaceurl.level |
INFO |
SpaceURL, SpaceValidator, SpaceURLParser logger |
| com.gigaspaces.common.spacefinder.level |
INFO |
SpaceFinder, CacheFinder related logger |
| com.gigaspaces.common.lookupfinder.level |
INFO |
LookupFinder related logger. When a cluster node is not found or when a jini:// SpaceFinder lookup is used. |
| com.gigaspaces.common.resourceloader.level |
INFO |
ResourceLoader related logger. Set to FINE/FINEST when resources where not loaded
or when suspect in class loader issues impact the configuration setting. Resources are space, container, cluster, properties, security etc. configuration and jar files. |
Service Grid – General
The Service Grid uses a number of different logger components. Each logger component along with what gets logged is listed below:
| Property |
Default Value |
Description |
| com.gigaspaces.grid.space.SpaceHandler.level |
INFO |
To troubleshoot Space deployments into the ServiceGrid. |
| org.jini.rio.level |
INFO |
|
| org.jini.rio.boot |
INFO |
ServiceBean bootstrapping mechanisms |
| org.jini.rio.event |
INFO |
EventConsumer and EventProducer details, event statistics |
| org.jini.rio.jsb |
INFO |
ServiceBean state transitions, exporter |
| org.jini.rio.associations |
INFO |
Creating and discovering declared Associations,
and controlling ServiceBean
advertise and unadvertise behavior based on Association state transitions |
| org.jini.rio.opstring |
INFO |
OperationalString parsing |
| org.jini.rio.qos |
INFO |
Compute Resource Platform and Measurable Capabilities, SLA Management and Thresholds |
| org.jini.rio.qos.RelocationPolicyHandler |
INFO |
RelocationPolicyHandler initialization and threshold processing |
| org.jini.rio.qos.ScalingPolicyHandler |
INFO |
ScalingPolicyHandler initialization and threshold processing |
| org.jini.rio.resources.client |
INFO |
JiniClient processing |
| org.jini.rio.resources.client.HeartbeatFaultDetectionHandler |
INFO |
HeartbeatFaultDetectionHandler processing |
| org.jini.rio.resources.client.StandardFaultDetectionHandler |
INFO |
StandardFaultDetectionHandler processing |
| org.jini.rio.resources.resource |
INFO |
Resource pools, Thread pools |
| org.jini.rio.resources.servicecore |
INFO |
Core service framework, Lease management |
| com.gigaspaces.start.level |
CONFIG |
Configuration Parser, SystemBoot, SystemConfig |
| com.gigaspaces.grid.space.GigaSpacesFaultDetectionHandler.level |
INFO |
Set to FINEST to troubleshoot FailOver and recovery issues with spaces. |
| com.gigaspaces.jmx.focalserver.FocalServer.level |
INFO |
|
| com.gigaspaces.ant |
INFO |
Ant system initialization,
Ant file download statistics, temporary file creation and removal and exception stacktraces. |
| com.gigaspaces.grid.bean |
INFO |
SpringBeanFactory loading of configured application context (Level.FINE) |
| com.gigaspaces.grid.lookup |
INFO |
Autonomic lookup service handling |
| com.gigaspaces.grid.master |
INFO |
Logging for the master in the bilt-in master worker framework |
| com.gigaspaces.grid.space |
INFO |
Space Association Management, GS Context, Space Handler |
| com.gigaspaces.grid.worker |
INFO |
GigaSpaceStationImpl, TaskWorker |
| com.gigaspaces.management.system.cpu |
INFO |
CPU, WindowsCPUHandler |
| com.gigaspaces.management.system.disk |
INFO |
DiskSpace, WindowsDiskHandler |
| com.gigaspaces.management.system.memory |
INFO |
Memory monitor logging, creation and reporting |
| com.gigaspaces.management |
INFO |
SystemCapabilities |
Service Grid – GSM
GSM logging properties:
| Property |
Default Value |
Description |
| org.jini.rio.monitor |
FINE |
Provision Monitor creation, OperationalString Manager transitions, ServiceElement manager transitions, ServiceBean provisioning, reaction to fault detection and recovery of ServiceBean instances |
| org.jini.rio.monitor.feedback |
INFO |
Information related to the feedback of Grid Service Containers, updating their qualitative and quantitative status |
org.jini.rio.monitor.provision |
INFO |
Logging of provision attaempts and GSC supportability of declared service requirements |
| org.jini.rio.monitor.services |
INFO |
Service management and monitoring for specific service elements in a deployment |
| org.jini.rio.monitor.sbi |
INFO |
Logging of ServiceBean instanceID management |
| org.jini.rio.tools.webster |
INFO |
Webster processing. Note that the definition of of the system property "webster.debug" will also result in logging messages to be sent to standard out |
| org.jini.rio.watch |
INFO |
Watch creation, ThresholdHandler processing, Watch and ThresholdHandler associations |
Service Grid – GSC
GSC logging properties:
| Property |
Default Value |
Description |
| com.gigaspaces.grid.gsc.level |
FINE |
Adaptive class annotator, Grid Service Container logging |
| org.jini.rio.cybernode.level |
FINE |
Cybernode processing,
Provision Monitor discovery and Provision Monitor Lease renewal management,
Cybernode SLA Threshold Management, Cybernode Environment |
Jini Services
Sets up logging levels for each of the Jini services.
Some of the logging levels are set to OFF. For troubleshooting-related reasons, you can change the logging level to one of the following levels: FINEST, WARNING, CONFIG, etc.
| Property |
Default Value |
Description |
| com.sun.jini.mahalo.startup.level |
INFO |
Jini Mahalo - Transaction Manager logging level FINE or FINEST for debugging and troubleshooting. |
| com.sun.jini.mahalo.destroy.level |
INFO |
|
| com.sun.jini.reggie.level |
INFO |
Jini Reggie - Lookup Service logging level.
# - FINE or FINEST for debugging and troubleshooting. |
| com.sun.jini.start.service.starter.level |
INFO |
Jini Service Starter logging level - FINEST for debugging and troubleshooting. |
| org.jini.rio.tools.webster.level |
|
Webster HTTPD logging level - FINEST for debugging and troubleshooting. |
| net.jini.discovery.LookupLocatorDiscovery.level |
WARNING |
To be used for Jini Lookup Locator Discovery debugging and troubleshooting. |
| net.jini.discovery.LookupDiscovery.level |
WARNING |
To be used for Jini Lookup Discovery debugging and troubleshooting. |
| net.jini.lookup.ServiceDiscoveryManager.level |
WARNING |
To be used for Jini Service Discovery debugging and troubleshooting. |
| net.jini.lookup.JoinManager.level |
WARNING |
To be used for Jini Join Manager debugging and troubleshooting. |
| net.jini.config.level |
WARNING |
Jini Configuration logging troubleshooting. |
.Net Client
For .Net client logging, see:
Modifying Logger Settings in Runtime using JMX
It us possible to change various logger settings while the system is running without needing to restart it.
This can be very useful in production environments or when the system needs to be troubleshooted, but at the same time cannot be restarted.
This can be achieved using the simple JMX JConsole:
- In the GigaSpaces Management Center (<GigaSpaces Root\bin\gs-ui.bat/sh), in the Deployments Details tab, right-click the GSC (since the space is running in the GSC), and click Launch JConsole.
- In JConsole, click the MBeans tab.
- Expand the java.util.logging tree node and locate the Logging tree node.
- Select the Operations tab.
- Type the logger's name and level for the arguments of the setLoggerLevel() method.
For example, If you want to change the org.jini.rio.monitor.provision level to ALL, type setLoggerLevel(org.jini.rio.monitor.provision, ALL) then click the Refresh button.

