Log profile properties  Log profile Java Logging subsystem properties

Appendix B: Repository Properties Reference

Log profile EAS subsystem properties

Description

These properties configure the output from a logging profile that uses the built-in EAS logging subsystem. The properties can be logically grouped as category properties, handler properties, and formatter properties.

Categories A category is a logical name used to categorize log messages. Internally in EAServer, different category names are used by different subsystems such as the servlet engine, as listed in “Category names”.

Categories can be arranged hierarchically by setting the parent property for handlers that should inherit settings from another handler. There is also a root category that configures the root-level settings. If you configure a category to inherit properties, but do not specify a parent, the root category settings are inherited.

Table B-8 lists the properties that configure a category. In the log profile, you define a category by configuring properties that begin with category.<cat-name>, where cat-name is replaced by the category name. For example, category.com.sybase.level configures the log level for the com.sybase category.

Table B-8: Category properties

Property name

Specifies

category.<root>.level

The log level for the root category.

category.<root>.handler

The handler for the root category.

category.<cat-name>.description

Specifies an optional description of the category.

category.<cat-name>.level

The log level for the category named <cat-name>.

category.<cat-name>.handler

The handler for the category named <cat-name>.

category.<cat-name>.parent

The parent handler.

category.<cat-name>.useparenthandlers

Whether to inherit settings from the parent handler.

category.<cat-name>.resourcebundlename

The resource bundle name for the category <cat-name>. Specify the name of a Java resource bundle name containing localized messages that are logged from Java code. If this property is not set, the default resource bundle is the class ResourceBundle in the package with the same name as the category. For example, the default resource bundle for the category com.sybase.jaguar.server is com.sybase.jaguar.server.ResourceBundle.

Handlers Handlers define how messages are logged. For example, you set properties to specify whether the output goes to the console or to a file, the log file name, whether to truncate log files on start-up, and so forth. To define a handler, specify a logical name when setting the handler properties in Table B-9 with <handler-name> replaced in the property name by the handler name.

Table B-9: Handler properties

Property name

Specifies

handler.<handler-name>.description

An optional description

handler.<handler-name>.type

The log output type

handler.<handler-name>.consoletype

For console output, whether to use standard output or standard error

handler.<handler-name>.filename

For file output, the log file name

handler.<handler-name>.truncate

For file output, whether to truncate the log file at start-up

handler.<handler-name>.maxsize

For file output, the maximum size

handler.<handler-name>.rotate

For file output, whether to rotate log files at start-up and when the maximum size is reached

handler.<handler-name>.formatter

The formatter name to use

handler.<handler-name>.archive

Whether to archive files at start-up and when the maximum size is reached

handler.<handler-name>.archive.filename

The location and naming pattern for archived log files

handler.<handler-name>.archive.compress

When archiving, whether to compress the log file

handler.<handler-name>.serverhost

When writing to a TCP socket, the host name for the socket connection

handler.<handler-name>.serverport

When writing to a TCP socket, the port number for the socket connection

Formatters Formatters specify the formatting pattern for logged messages. To define a formatter, specify a logical name when setting the handler properties in Table B-10, with <formatter-name> replaced in the property name by the formatter name.

Table B-10: Formatter properties

Property name

Specifies

formatter.<formatter-name>.description

An optional description

formatter.<formatter-name>.dateformat

The format for timestamps in log messages

formatter.<formatter-name>.messageformat

The format pattern for the message text

See also

Log profile properties, com.sybase.jaguar.logprofile.subsystem




category.<cat-name>.description

Description

Specifies an optional description of the category named <cat-name>.

Syntax

The text of the description.

See also

“Categories”.




category.<cat-name>.handler

Description

Specifies the handler for the category named <cat-name>.

Syntax

The handler name. “Handlers” describes how to define a handler.

See also

“Categories”.




category.<cat-name>.level

Description

Specifies the log level for the category named <cat-name>.

Syntax

One of the error levels listed in Table B-11. The error level specifies which messages are logged. Only messages of the specified security level or greater are logged. Table B-11 lists the levels in ascending order of severity.

Table B-11: EAS Log subsystem error levels

Level

To indicate

ALL

All messages are logged.

FINE

Debug messages are logged.

FINER

Same effect as FINE.

FINEST

Same effect as FINE.

CONFIG

A configuration error has been detected. You should correct the problem.

INFO

An informational or status message. For example, the name server has finished binding components.

WARN

Warning messages are logged. For example, if the server is in a cluster and other members are not found.

ERROR

An error has occurred that prevents completion of a requested action. For example, a component has thrown an uncaught exception and its transaction is being rolled back.

FATAL

An error has occurred that indicates the server should terminate.

OFF

No messages are logged.

See also

“Categories”, category.<root>.level




category.<cat-name>.parent

Description

Specifies the parent of the category named <cat-name>.

Syntax

The name of the parent category. If not specified, the default is the root category.

See also

“Categories”, category.<cat-name>.useparenthandlers




category.<cat-name>.resourcebundlename

Description

Specifies the name of the Java resource bundle containing localized messages.

Syntax

The full Java class name of the resource bundle, which must extend java.util.ResourceBundle. Do not include language or country code extensions.

See also

“Categories”




category.<cat-name>.useparenthandlers

Description

For the category named <cat-name>, specifies whether to inherit settings from the parent handler. The parent is specified by the category.<cat-name>.parent property. If this property is not set, the parent is the root category.

Syntax

true or false.

See also

“Categories”, category.<cat-name>.parent




category.<root>.level

Description

Specifies the log level for the root category.

Syntax

Same as category.<cat-name>.level.

See also

category.<root>.handler, category.<cat-name>.level, “Categories”




category.<root>.handler

Description

Specifies the handler for the root message category.

Syntax

The handler name. “Handlers” describes how to define a handler.

See also

category.<root>.level, category.<cat-name>.handler, “Categories”




formatter.<formatter-name>.dateformat

Description

Specifies the timestamp format for the formatter named <formatter-name>.

Syntax

The pattern for the timestamps embedded in log messages, as converted to strings by java.text.SimpleDateFormat. For details, see the the DateFormat API documentation.

See also

“Formatters”, formatter.<formatter-name>.messageformat




formatter.<formatter-name>.description

Description

Specifies an optional description for the formatter named <formatter-name>.

Syntax

The text of the description.

See also

“Formatters”




formatter.<formatter-name>.messageformat

Description

Specifies the message format for the formatter named <formatter-name>.

Syntax

The pattern for the message text. You can use the placeholders in Table B-12 to indicate the position of the message parts.

Table B-12: Message format placeholders

Placeholder

Represents

%LN

The logging category name

%MC

Message code (number)

%ML

Message level (severity)

%MT

Message text

%SN

Sequence number

%SF

Source file name

%SL

Line number in the source file

%SM

Method name in the source file

%TI

Thread ID

%TH

Exception thrown (if available)

%TS

The timestamp, formatted as specified by the formatter.<formatter-name>.dateformat property

%NL

A line break

See also

“Formatters”, formatter.<formatter-name>.dateformat




handler.<handler-name>.archive

Description

For the handler named <handler-name>, when writing to a file, specifies whether the previous log file should be archived when restarting servers or when the maximum size is reached.

Syntax

true or false. The default is false. If you enable archiving, specify the archive file name by setting handler.<handler-name>.archive.filename.

See also

“Handlers”, handler.<handler-name>.type, handler.<handler-name>.maxsize, handler.<handler-name>.archive.filename, handler.<handler-name>.archive.compress




handler.<handler-name>.archive.compress

Description

For the handler named <handler-name>, when file archiving is enabled, specifies whether to compress archived files.

Syntax

true or false. The default is false. If you enable compression, the resulting archive name is the value of handler.<handler-name>.archive.filename plus the “.zip” extension.

See also

“Handlers”, handler.<handler-name>.archive handler.<handler-name>.archive.filename




handler.<handler-name>.archive.filename

Description

For the handler named <handler-name>, when file archiving is enabled, specifies the archive file name.

Syntax

The full path to the archive file, using ‘/’ (forward slash) as the directory separator. You can use the placeholders described in Table B-13.

See also

“Handlers”, handler.<handler-name>.archive, handler.<handler-name>.archive.compress




handler.<handler-name>.consoletype

Description

For the handler named <handler-name>, when writing to the console, specifies whether to write to standard error or standard output.

Syntax

One of the following:

Value

To indicate

stderr

Standard error

stdout

Standard output

See also

“Handlers”, handler.<handler-name>.type




handler.<handler-name>.description

Description

Specifies the output type for the handler named <handler-name>.

Syntax

The descriptive text.

See also

“Handlers”




handler.<handler-name>.filename

Description

For the handler named <handler-name>, when writing to a file, specifies the file name.

Syntax

The full path to the output file, using ‘/’ (forward slash) as the directory separator. You can use the placeholders described in Table B-13:

Table B-13: File name and path placeholders

Placeholder

Specifies

${JAGUAR}

The EAServer installation directory (specified by the JAGUAR environment variable)

${JAGEXEDIR}

The location of binaries in the EAServer installation ($JAGUAR/bin on most platforms)

${JAGSRVNAME}

The server name, as displayed in EAServer Manager

%t

The time of day when the file was created, formatted as HHMMSS

%d

The date (month, day of month, and year) when the file was created, formatted as DDMMYYYY

See also

“Handlers”, handler.<handler-name>.type




handler.<handler-name>.formatter

Description

For the handler named <handler-name>, specifies the formatter name.

Syntax

The formatter name. See “Formatters”.

See also

“Handlers”, “Formatters”




handler.<handler-name>.maxsize

Description

For the handler named <handler-name>, when writing to a file, specifies the maximum size the file can reach before rotation or archiving occurs.

Syntax

To specify the size in kilobytes:

nk

To specify the size in megabytes:

nm

Where n is a positive integer. To specify an unlimited size, use -1 (the default).

Usage

If you specify a maximum size, you should enable rotation or archiving by setting the handler.<handler-name>.rotate or handler.<handler-name>.archive properties, respectively.

See also

“Handlers”, handler.<handler-name>.type, handler.<handler-name>.archive, handler.<handler-name>.rotate




handler.<handler-name>.rotate

Description

For the handler named <handler-name>, when writing to a file, specifies whether the previous log file should be renamed when restarting servers or when the maximum size is reached.

Syntax

true or false. The default is false. If you enable rotation, the log file is renamed with a sequential numeric extension when a new file is started. For example, if the file is Jaguar.log, previous versions are named Jaguar.log.1, Jaguar.log.2, and so forth.

See also

“Handlers”, handler.<handler-name>.type, handler.<handler-name>.archive.filename, handler.<handler-name>.maxsize




handler.<handler-name>.serverhost

Description

For the handler named <handler-name>, when writing to a TCP socket, specifies the host name for the socket connection.

Syntax

The server host name or IP address.

See also

“Handlers”, , handler.<handler-name>.serverport handler.<handler-name>.type




handler.<handler-name>.serverport

Description

For the handler named <handler-name>, when writing to a TCP socket, specifies the port number for the socket connection.

Syntax

The server port number.

See also

“Handlers”, , handler.<handler-name>.serverhost handler.<handler-name>.type




handler.<handler-name>.truncate

Description

For the handler named <handler-name>, when writing to a file, specifies whether the previous log file should be truncated when restarting servers.

Syntax

true or false. The default is false.

See also

“Handlers”, handler.<handler-name>.type




handler.<handler-name>.type

Description

Specifies an optional description for the handler named <handler-name>.

Syntax

One of the following:

Value

To indicate

file

Output to a text file

console

Output to the console (standard error or standard out)

tcp

Output to a TCP socket

See also

“Handlers”





Copyright © 2005. Sybase Inc. All rights reserved. Log profile Java Logging subsystem properties