IBM Content Search Services log files
The IBM® Content Search Services server generates logging information during server startup, indexing, and searching. The log files contain configuration information, warnings, errors, and debugging information that can be useful for troubleshooting specific issues. The command-line tools also generate log files.
By default, the following log files are created in the <server-home>\log directory. The <server-home> directory is typically \IBM\Content Search Services\CSS Server.
- adminAudit.csv: Collects information about configuration changes that are made by the API.
- commandLineTools*.log: Records command-line tool information, warning, and error messages.
- default*.log: Contains information, warning, and error messages that are logged during server activity.
- monitor*.csv: Contains information about the indexing status, queue status, query load, and other system statistics.
- serverConfiguration.log: Provides information about the server configuration on startup.
- trace*.log: Contains trace information, warning, and error messages. You can enable tracing by using the administration tool and set the log level by using the configuration tool.
- version.log: Records the history of version changes for some of the main components of the server, such as the server JAR file.
For information about how to set the level of IBM Content Search Services server logging, see Setting the server log severity level.
In addition, the Content Platform Engine logs indexing failures to the p8_server_error.log file by default. For more information, see Propagating document-related failures to objects. The Content Platform Engine server provides trace logging if you enable the CBR subsystem for tracing. Unless otherwise instructed, enable error tracing and CBR summary tracing to trace the problem when it occurs. For more information, see Content Engine log files.
Modifying IBM Content Search Services log file properties
The IBM Content Search Services log
files use java.util.logging.FileHandler settings.
To
change the directory location of a log file, edit the appropriate
logging properties files in the <server-home>\config directory.
The ecmts_logging.properties file specifies the
trace log and the default error log properties; the ecmts_config_logging.properties file
specifies the command-line tool log properties. If you make a change
to the ecmts_config_logging.properties file,
you must restart IBM Content Search Services for
the changes to take effect. Set the <FileHandler>.pattern parameter
in the properties files to a directory where you want to store the
logs. For example, in the ecmts_logging.properties file,
set the java.util.logging.FileHandler.pattern parameter
to specify a different path for the trace log, and set the com.ibm.es.nuvo.logging.FileHandlerForErrors.pattern parameter
to specify a different path for the default error log.
You can
specify the approximate amount of data (in bytes) to write to any
one file by setting the limit parameter, and can
specify the number of output files (such as trace0.log, trace1.log)
by setting the count parameter. By default, the trace
log and default error log limit parameter is set
to 10000000 (10 MB), the trace log count parameter
is set to 10, and the default error log count parameter
is set to 20. The command-line tools logging properties use the java.util.logging.FileHandler defaults
(unlimited for the data limit and 1 for the number of output files),
but you can modify these defaults by including entries similar to
the following entries in the ecmts_config_logging.properties file:
java.util.logging.FileHandler.limit
= 10000000
java.util.logging.FileHandler.count
= 10
To turn on query logging, set
the com.ibm.es.nuvo.search.SearchableImpl.level parameter
to a valid logging level, preferably FINE.
IBM Content Search Services logging levels
Every message in the IBM Content Search Services log file has an associated level that indicates the message type. Logging levels, in descending order of severity, are defined as follows:
SEVERE- Errors and exceptions that occur during the execution of the server.
Typically,
SEVEREmessages include detailed information with the stack trace that can help identify the cause of the problem. WARNING- Mild problems that might require the attention of an administrator, such as a missing value for a setting with a default value, or the truncation of a document during indexing.
INFO- Informational messages that are generated during system operation, such as messages about server configuration and the state of server startup.
FINE- Detailed messages for debugging purposes, such as request headers and parsed queries.
FINER- More details, such as the results of document parsing during indexing. Important: Do not use this logging level unless instructed to do so by a support representative from IBM Customer Support. Because this logging level can impact performance, do not use it any longer than is necessary.
FINEST- The most detailed level. This includes all printouts, entries,
and exits from various functions. Important: Do not use this logging level unless instructed to do so by a support representative from IBM Customer Support. Because this logging level can impact performance, do not use it any longer than is necessary.
The default logging level is INFO,
which means that messages of levels SEVERE, WARNING,
and INFO are generated.