cctklog4j.xml reference

Applies to: FAST Search Server 2010

Use the cctklog4j.xml file to control the logs created by the FAST Search Lotus Notes connector and the FAST Search database connector. This includes console logs, file logs, or a Microsoft FAST Search Server 2010 for SharePoint network logger. You can also specify the level of detail in these logs.

The FAST Search connector reads the cctklog4j.xml file at startup for log configuration instructions. This configuration file sets a log level for each connector component, which provides a filter for the generated messages. For example, you can set INFO level logs for the main connector component, and ERROR level logs for the libraries used by the connector.

Elements quick reference

There are three kinds of elements in cctklog4j.xml.

cctklog4j.xml file format

XML elements in cctklog4j.xml begin with < and end with />.

The basic format is as follows:

<appender name=["value"]>

    <param name=["value"] value=["value"] />

    <layout class=["value"] >

        <param name=["value"] value=["value"] />

    </layout>

</appender>

<logger name=["value"]>

    <level value=["value"] />

</logger>

<root>

    <level value=["value"] />

    <appender-ref ref=["value"] />

</root>

For example:

<logger name="org.apache.axis.utils.JavaUtils">
     <level value="ERROR"/>
</logger>

Elements and attributes are case-sensitive, attribute values are not. Attribute values must be enclosed in quotation marks (" ").

An element definition can span multiple lines. Spaces, carriage returns, line feeds, and tab characters are ignored in an element definition.

For example:

<logger name="org.apache.axis.utils.JavaUtils">

    <level value="ERROR"/>

</logger>

The <log4j:configuration> element is a special case and is required. All other elements are contained within the <log4j:configuration> element, and the element is closed with </log4j:configuration>.

You can add comments anywhere, delimited by <!-- and -->.

For example:

<!-- Setting the log level to ERROR avoids warnings about MIME -->
<logger name="org.apache.axis.utils.JavaUtils">
    <level value="ERROR"/>
</logger>

cctklog4j.xml appender elements reference

Appender elements define the logging output format and physical destination of the logs.

The elements are additionally specified with sub-parameters and layout classes.

cctklog4j.xml appender console element reference

Use the console appender to specify console output and message contents.

Example

The following example configures output with a specific message layout:

<appender name="console" class="org.apache.log4j.ConsoleAppender">
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d{ABSOLUTE} %-5p [%c{1}] %m%n"/>
    </layout>
</appender>

cctklog4j.xml appender rollingfile element reference

The rollingfile appender logs messages to a configured file until that file reaches a specified size. When the log file reaches the maximum size, the current file is renamed (a sequential number is added to the file name) and a new log file is created. This appender also controls the maximum number of files in a rolling set, and the contents of log messages.

Example

The following example sets up a rolling file appender, rotating on 10 log files of 5000 KB each:

<appender name="rollingfile" class="org.apache.log4j.RollingFileAppender">
    <param name="Append" value="true"/>
    <param name="File" value="log/${cctk.module}connector.log"/>
    <param name="MaxFileSize" value="5000KB"/>
    <param name="MaxBackupIndex" value="10"/>
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d{ISO8601} %-5p [%c{1}] %m%n"/>
    </layout>
</appender>

The files are named lotusnotesconnector.log.1, lotusnoteconnector.log.2, and so on Messages include time stamp, level, class name, and message content.

cctklog4j.xml appender net element reference

The net appender specifies the FAST Search Server 2010 for SharePoint network logger file name and message contents.

Example

The following example locates the network logger at localhost, port 13415:

<appender name="net" class="com.fastsearch.esp.cctk.logging.ESPLogServerAppender">
    <param name="LogHost" value="localhost"/>
    <param name="LogPort" value="13415"/>
    <param name="LogModuleName" value="${cctk.module}connector"/>
</appender>

The module name in the logs is lotusnotesconnector or jdbcconnector.

cctklog4j.xml logger element reference

Use the logger element to define the level of verbosity in the logs for different connector components, which are defined through the package names for classes. The packages should be left as is (e.g., do not remove a logger), but you can change the level of verbosity.

Example

<logger name="com.fastsearch.esp.cctk">
    <level value="INFO"/>
</logger>

<logger name="org.apache.axis.utils.JavaUtils">
    <level value="ERROR"/>
</logger>

<logger name="org.apache.commons.httpclient">
    <level value="ERROR"/>
</logger>

<logger name="com.fastsearch.esp.connectors.lotus">
    <level value="INFO"/>
</logger>

<logger name="com.fastsearch.esp.connectors.lotus.userdirectory">
    <level value="INFO"/>
</logger>

<logger name="com.fastsearch.esp.connectors.jdbc">
    <level value="INFO"/>
</logger>

cctklog4j.xml root element reference

Use the root element to define log appenders that should be used and the level of verbosity for components that are not individually specified in the cctklog4j.xml configuration.

Example

<root>

    <level value="WARN"/>

    <appender-ref ref="console"/>

    <appender-ref ref="rollingfile"/>

    <appender-ref ref="net"/>

</root>