Module org.apache.sis.util

Package org.apache.sis.util.logging

Class PerformanceLevel

Object

Level

PerformanceLevel

All Implemented Interfaces:

Serializable

public final class PerformanceLevel
extends Level

Logging levels for data processing with execution time measurements. Those levels are used for events that would normally be logged at Level.FINE, but with the possibility to use a slightly higher level if execution time was long. Different logging levels - SLOWNESS and SLOWER - are provided for logging only the events taking more time than some thresholds. For example, the console could log only the slowest events, while a file could log all events considered slow.

Every levels defined in this class have a value between the Level.FINE and Level.CONFIG values. Consequently, performance logging are disabled by default, and enabling them imply enabling configuration logging too. This is done that way because the configuration typically have a significant impact on performance.

Enabling performance logging

Performance logging can be enabled in various ways. Among others:

• The $JAVA_HOME/lib/logging.properties file can be edited in order to log messages at the FINE level, at least for the packages of interest.
• The Logger.set­Level(Level) can be invoked, together with Handler.set­Level(Level) on all relevant logging targets (console or file, etc.).
• The Monoline­Formatter.install(Logger, Level) convenience method can be invoked.

Since:

0.3

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Performance­Level	SLOWER	The level for logging only events slower than the ones logged at the SLOWNESS level.
static final Performance­Level	SLOWNESS	The level for logging relatively slow events.

Fields inherited from class Level

ALL, CONFIG, FINE, FINER, FINEST, INFO, OFF, SEVERE, WARNING

Method Summary

Modifier and Type	Method	Description
static Level	for­Duration(long duration, Time­Unit unit)	Returns the level to use for logging an event of the given duration.
String	get­Localized­Name()	Return the name of this level for the current default locale.
long	get­Min­Duration(Time­Unit unit)	Returns the minimal duration for logging an event at this level.
void	set­Min­Duration(long duration, Time­Unit unit)	Sets the minimal duration for logging an event at this level.

Methods inherited from class Level

equals, get­Name, get­Resource­Bundle­Name, hash­Code, int­Value, parse, to­String

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Field Details

SLOWNESS

public static final PerformanceLevel SLOWNESS

The level for logging relatively slow events. By default, only events having an execution time equals or greater than 1 second are logged at this level. However, this threshold can be changed by a call to SLOWNESS.set­Min­Duration(long, Time­Unit).

Since:

1.3

SLOWER

public static final PerformanceLevel SLOWER

The level for logging only events slower than the ones logged at the SLOWNESS level. By default, only events having an execution time equals or greater than 10 seconds are logged at this level. However, this threshold can be changed by a call to SLOWER.set­Min­Duration(long, Time­Unit).

Method Details

forDuration

public static Level forDuration(long duration,
 TimeUnit unit)

Returns the level to use for logging an event of the given duration. The method may return Level.FINE, SLOWNESS or SLOWER depending on the duration.

Parameters:

duration - the event duration.

unit - the unit of the given duration value.

Returns:

the level to use for logging an event of the given duration.

getMinDuration

public long getMinDuration(TimeUnit unit)

Returns the minimal duration for logging an event at this level.

Parameters:

unit - the unit in which to express the minimal duration.

Returns:

the minimal duration in the given unit.

setMinDuration

public void setMinDuration(long duration,
 TimeUnit unit)
                    throws IllegalArgumentException

Sets the minimal duration for logging an event at this level. Invoking this method may have an indirect impact of other performance levels:

• If the given duration is longer than the duration of slower levels, then the latter are also set to the given duration.
• If the given duration is shorter than the duration of faster levels, then the latter are also set to the given duration.

Parameters:

duration - the minimal duration.

unit - the unit of the given duration value.

Throws:

Illegal­Argument­Exception - if the given duration is zero or negative.

getLocalizedName

public String getLocalizedName()

Return the name of this level for the current default locale.

Overrides:

get­Localized­Name in class Level

Returns:

name of this level for the current locale.

Since:

1.2