Logger.xml file

The Logger.xml file is located at the root level of the /conf directory and is the configuration file for the logging file system. Logger.xml contains the elements and information used to configure log files.You can edit this file to add or change configuration information, including the location of the log files. The default location of the log files is in the /logs directory in the server installation directory.

Log files are written in English. Field names displayed in the log file are in English. Some content within the log file, however, may be in another language, depending on the filename and the operating system. For example, in the Access.log file, the columns x-sname and x-suri-stem show the name of the stream. If the name of the recorded stream is in a language other than English, the name is written in that language, even if the server is running on an English-language operating system.

The Logging section in the Server.xml file enables or disables the log files.

To see the element structure and default values, see the Logger.xml file installed in the RootInstall/conf/ folder.

Note: Log file rotation cannot be disabled. To effectively turn off rotation, choose a large maximum size and a long maximum duration for the log files.

Access

Container element.

The elements nested within this container configure the Access log settings.

Contained elements

LogServer, Directory, FileName, Time

admin

Container element.

The elements nested within this container configure the admin log settings.

Contained elements

LogServer

Application

Container element.

The elements nested within this container configure the Application log file settings.

Contained elements

Directory, Time, Rotation

AuthEvent

Container element.

The elements in this section configure the AuthEvent log file settings. For more information, see the Plug-in Developer Guide at www.adobe.com/go/learn_fms_plugindev_en.

AuthMessage

Container element.

The elements in this section configure the AuthMessage log file settings. For more information, see the Developer Guide at www.adobe.com/go/learn_fms_plugindev_en.

Contained elements

Directory, Time. Rotation

core

Container element.

The elements nested within this container configure the core log settings.

Contained elements

LogServer

Delimiter

Specifies whether or not to use a single quotation mark (') as a delimiter to separate the fields in the log file.

A delimiter is used to separate the fields in the log file. The use of the number sign (#) as a delimiter is not recommended, since # is used as the comment element in the Logger.xml file.

The following characters are not allowed as delimiters:

  • triple quotation marks (''' )

  • paired double quotation marks ("")

  • comma (,)

  • colon (:)

  • hyphen (-)

Diagnostic

Container element.

The elements in this section configure the diagnostic log file.

Contained elements

Directory, Time. Rotation

Directory

Specifies the directory where the log files are located.

By default, the log files are located in the logs directory in the server installation directory.

Example

<Directory>${LOGGER.LOGDIR}</Directory>

See also

Time, Rotation

DisplayFieldsHeader

Formatting element. Specifies how many lines to write to the log file before repeating the field headers. The default line count is 100 lines.

Example

<DisplayFieldsHeader>100</DisplayFieldsHeader>

edge

Container element.

The elements nested within this container configure the edge log settings.

Contained elements

LogServer

EscapeFields

Formatting element. This element controls whether or not the fields in the log file are escaped when unsafe characters are found. This optional flag can be set to enable or disable. By default, it is set to enable.

The unsafe characters are as follows: the space character; open or closed angle brackets (< >); a double quotation mark ("); the number sign (#); the percent sign (%); open or closed curly braces ({ }); bar (|); the carat (^); the tilde (~); square brackets ([ ]); and the apostrophe (' ).

Example

<EscapeFields>enable</EscapeFields>

Events

Specifies the events written to the log file.

Specify events in a semicolon-separated list. The keyword * instructs the server to log all events. For a list of events that are recorded in the Access log file, see Access events defined in access logs.

See also

Fields

Fields

Specifies which fields for an event are logged in the Access log file.

Fields are associated with the events found in the Access log file. The field specification is a semicolon-separated list of one or more fields associated with an event in the log file.

The keyword * specifies that all fields are to be logged. Fields without data are left empty. Adobe recommends that you include the following fields in the fields to be logged: the type, category, date, and time fields.

For a list of fields associated with events in the Access log file, see Fields in access logs. Not every field is associated with each event in the log file.

See also

Events

FileIO

Container element.

The elements in this section configure the settings for the File plug-in log file settings. For more information, see the Plug-in Developer Guide at www.adobe.com/go/learn_fms_plugindev_en.

Contained elements

Directory, Time, Rotation

FileName

Specifies the name of the Access log file.

The Access log filename includes a date stamp and version number. Y represents the year of its creation; the format YYYY must be used. M represents the month of its creation; the formats M or MM are both allowed. D represents the day of the month of the file’s creation; the formats D or DD are both allowed. N represents the version number of the file. Note that there is no limit on the number of versions.

The repetition of a letter represents the number of digits. For example, M represents 4 (April). MM represents 04 (April).

Example

access.2007103043.log

This example identifies version 43 of the access log file for October 30, 2007.

History

Specifies the maximum number of log files to keep.

The files are named access.01.log, access.02.log, access.03.log, and so on. The default number of files to retain is 5.

Example

<History>5<History>

HostPort

Specifies the IP and port of the log server.

Example

<HostPort>xxx.xxx.xxx.xxx:1234</HostPort>

Logger

Root element.

The Logger element is a container for all the other elements in Logger.xml.

LogServer

Container element.

The elements nested in this section configure the server to send messages to a remote log server.

master

Container element.

The elements nested within this container configure the master log settings.

Contained elements

LogServer

MaxSize

Specifies the maximum log file size in bytes. The default file size is 10240 KB, or approximately 1 MB.

Example

<Maxsize>10240</MaxSize>

QuoteFields

Formatting element. Specifies whether or not to use quotation marks to surround those fields in the log file that include a space.

This element can be set to enable or disable. By default, it is set to disable.

Example

<QuoteFields>disable</QuoteFields>

Rename

Specifies a new name for log files when rotation occurs. The default is true.

If Rename is set to true, application.00.log is renamed application.01.log, and application.01.log is renamed application.02.log (and so on) when it is time to rotate the log files. This occurs until the maximum history setting is reached. The log file with the highest version number keeps the oldest log history.

If Rename is set to false, a new log file is created with the next available version when rotation occurs. The log file with the lowest version number keeps the oldest log history.

Examples

<Rename>true</Rename>

Rotation

Container element.

The elements in this section configure the rotation of the log files.

Contained elements

MaxSize, Schedule, History, Rename

Schedule

Specifies the rotation schedule for the log files.

There are two types of scheduling: daily rotation and rotation that occurs when the log exceeds a specified length.

Examples

If the type attribute is daily, the server rotates the log files every 24 hours.

<Schedule type="daily"></Schedule>

If the type attribute is hh:mm, the timestamp 00:00 causes the file to rotate every midnight.

<Schedule type="hh:mm"></Schedule>

If the type attribute is duration, rotation occurs when the duration of the log exceeds a specified length. The duration is specified in minutes.

<Schedule type="duration"></Schedule>

ServerID

By default, the value of the ServerID element is the IP address of the server whose events are being logged.

Example

<ServerID>xxx.xxx.xxx.xxx:1234</ServerID>

Time

The Timefield in a log file can be logged either in UTC (GMT) or local time. Valid values are utc, gmt, or local.

The setting for the Time element can be used to override the server-wide configuration. The default is local time.

See also

Logging