loggerconfig.xml reference

  • Article

 

Applies to: FAST Search Server 2010

Use LoggerConfig.xml to configure routing and filtering of log messages sent from the FAST Search Server 2010 for SharePoint components. The logging process consists of three steps. The first step is configured in LoggerConfig.xml. The last two steps, for the local and main log servers, are configured in LogServerConfig.xml.

Warning

Any changes that you make to this file will be overwritten and lost if you:

  • Run the Set-FASTSearchConfiguration Windows PowerShell cmdlet.

  • Install a FAST Search Server 2010 for SharePoint update or service pack.

To avoid losing your changes, make sure that you back up this file after you have modified it.
Remember to reapply your changes after you run the Set-FASTSearchConfiguration Windows PowerShell cmdlet or install a FAST Search Server 2010 for SharePoint update or service pack.

The LoggerConfig.xml configuration file determines how FAST Search Server 2010 for SharePoint processes output log messages. Log messages are usually sent to the local log server for further routing and filtering, in addition to being sent to the log file and console output. For information about the configuration of the local and main log servers, see logserverconfig.xml.

LoggerConfig.xml includes a list of destinations which is used to set up the logging targets where log messages are sent. The programs list configures log level filtering for individual log sources. If an incoming log message does not match any of the defined programs, the default program entry (name=default) is used instead.

You can edit the installed version of LoggerConfig.xml to tune the existing values or to add more program elements to override filtering and routing for specific log sources. However, in most cases, the default values will be acceptable.

Customizing LoggerConfig.xml

Note

To modify a configuration file, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.

Use a text or XML editor to change this file. Edits will not take effect until the FAST Search Server 2010 for SharePoint components related to the configuration change are restarted.

Element quick reference

LoggerConfig.xml uses the following elements:

Element Description

<config>

Top level element

<destinations>

 

<netdestination>

<filedestination>

<stdoutdestination>

A list of log targets

 

Configuration for network forwarding of log messages (to the local log server)

Configuration for logging to files

Configuration for output to the console or a pipe

<programs>

 

<program>

 

<output>

A list of log sources

 

Routing and filtering specifications for a log source

 

Specifications for routing log messages to a particular destination, with a log level threshold filter

LoggerConfig.xml file format

LoggerConfig.xml is an XML file and follows all conventions and syntax rules that are defined for the XML file format.

The basic file structure is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<config version="2">

  <destinations>
    ... specification of where logs can be sent
  </destinations>

  <programs>
    <program name="default">
      ... routing to destination with log level filtering
    </program>
    ... add more program elements here to override defaults
  </programs>

</config>

config

This is the top level element of LoggerConfig.xml..

Attributes

Attribute Value Description

version

2

The version attribute provides future expansion of the file format. Currently only 2 is valid.

destinations

This element is a container for one or more destination elements.

Element Description

netdestination

Configures network forwarding of log messages to the local log server

filedestination

Configures logging to files

stdoutdestination

Configures output to the console or a pipe

netdestination

This element defines a network log destination.

Attributes

Attribute Value Description

name

string

Symbol used to reference this log destination from a program element

Elements

Element Value Description

hostname

string

Network address of the local log server

port

integer

TCP port number of the local log server

timeout

integer

Timeout in seconds

retrycount

integer

Maximum number of attempts to write a log entry

retryperiod

integer

Delay between each retry attempt, in seconds

Remarks

This destination uses a TCP/IP network connection to forward logs to the local log server.

filedestination

This element defines a log destination which writes log files to a specified folder.

Attributes

Attribute Value Description

name

string

Symbol used to reference this log destination from a program element

Elements

Element Value Description

directory

string

Directory where the log files are created

backups

integer

Number of archived log files to keep

rotatesize

integer

Maximum size, in bytes, for each log file

rotatetime

HHMM

Time of day when log files are archived, regardless of size. For example, 0100 indicates that log files will be archived at 1 AM.

Remarks

You can specify either a rotatesize or a rotatetime element to define different procedures for archiving log files.

stdoutdestination

This element defines a log output to the console or to a command-line process pipe.

Attributes

Attribute Value Description

name

string

Symbol used to reference this log destination from a program element

Remarks

This destination logs messages to the standard output stream (stdout).

programs

This element specifies a list of log sources.

Elements

Element Description

program

Defines routing and filtering for a log source

program

This element defines routing and filtering for a log source.

Attributes

Attribute Value Description

name

string

Process name

Elements

Element Description

output

Defines routing of log messages to a specific destination, with a specified log level threshold filter

Example

The following example defines routing and filtering for log messages from the process named searchctrl-search. Only messages that have the log level set to INFO and higher are routed to the server destination. Messages with log level set to VERBOSE and higher are sent to the file destination. Log messages that have lower log levels are discarded.

<program name="searchctrl-search">
  <output destination="server" threshold="info"/>
  <output destination="file"   threshold="verbose"/>
</program>

output

Defines routing of log messages to a specific destination, with a specified log level threshold filter

Attributes

Attribute Value Description

destination

string

Symbol referencing a configured destination element

threshold

CRITICAL|ERROR|WARNING|INFO|VERBOSE|DEBUG

  • CRITICAL - route only CRITICAL messages.

  • ERROR - route messages that have log level ERROR and above.

  • WARNING - route messages that use log level WARNING and above.

  • INFO - route messages that use log level INFO and above.

  • VERBOSE - route messages that use log level VERBOSE and above.

  • DEBUG - route all log messages.

Example

The following example routes all messages to the destination named file:

<output destination="file" threshold="debug" />

See Also

Concepts

logserverconfig.xml reference