Searching for log files to view or download
Downloading a selected log file
Log files record Poetic activity. The information in log files can be used to trace activity or troubleshoot problems. Poetic generates several different types of log files for different Poetic functions. Types of Poetic log files include:
| Application server log | Records:
|
| SQL logs | Records SQL queries from Poetic to the database. |
| Key generator logs | Records calls from Poetic to key generators. The log files include the key generation message for each call. |
| Profile logs | Records the object count, interprocess request calls, and execution time in order to monitor the performance of the application server. |
| Plugin logs | Records calls from Poetic plugins to external systems. Includes calls for:
|
Log files are by default created in a logs folder in the webapp or backapp folder on each application server. Log files are created daily - there is a separate log file for each day. The location is configured in log4j.xml. See the Poetic Installation Guide for details on configuring the log files.
From Poetic, you can search for log files, view log file entries, and download log files.
Log file names use the following naming convention: logFileType_YYYYMMDD.log
Where:
The log file names can be customized in log4j.xml. See the Poetic Installation Guide for details on configuring the log files.
Each log file entry consists of the following information:
[#|HH:MM:SS|logEntryLevel|parameters|messageText|#]
Where:
Types of entries include:
| INFO | Used for entries that provide information about an action that has occurred. |
| ERROR | Used to record errors. |
| CONFIG | Used to record changes to configuration. |
| CROSS_CALL | Used in the profile logs whenever there is an interprocess request (One request calls another request internally). |
| REQUEST | Used to record a request to Poetic. |
| RESPONSE | Used to record a response to a request. |
| TRACE | Used in the SQL logs for a SQL trace. |
| WARN | Used to record warnings. |
| FATAL | Used to record a fatal error. |
| PROFILE | Used in the profile logs. |
| SQL | Used in the SQL logs to record a SQL query. |
| KEYGEN_NOTICE | Used in the key generator logs to record a notice. |
| KEYGEN_ERROR | Used in the key generator logs to record an error. |
| POETICREQUEST | Used in the profile logs to record a request from Poetic. |
| POETICRESPONSE | Used in the profile logs to record a response to a request. |
The parameter list can include the following values:
| SID=sessionID | The session identifier. |
| LOGIN=loginName | The login name of the Poetic user. |
| JOB=backgroundJobName | The name of the background job that was running. |
| DB_SID=databaseSessionID | The session identifier for the connection to the database. |
| EXECUTION_TIME=processingTime | The length of time in milliseconds it took to process a request. |
| METHOD=VALIDATE or GENERATE | Used in the key generator logs to indicate whether Poetic was validating a key generation request or actually generating the keys. |
You manage log files from the Search Log Files page. To display the Search Log Files page:
The Log files option also is available on the Tools menu.
The General Search tab of the Search Log Files page allows you to search for log files using:
| Machine name | The name of the instance for which to display the server logs. An instance represents a unique combination of the server identifier, IP address, and port number.
The Machine name dropdown contains the list of available instances. The instance name combines the following values from PoeticAppServer.properties, separated by colons:
|
| Machine ID | The last two digits of the IP address of the server. The Machine ID dropdown contains the list of available addresses. |
| Log type | The type of log file to include in the results. The Log type dropdown contains the list of available types. |
| Update date | The date range for which to include log files. |
| File size greater than | The minimum file size, in MB, for the log files to include in the results. |
For some errors, Poetic displays an error page that includes an error code. The format of the error code is:
errorIdentifier-addressLastTwoDigits-dateTimeStamp-sessionIdentifier
Where:
| errorIdentifier | Identifies the type of error. For example, 500 indicates a general server failure. |
| addressLastTwoDigits | The last two digits of the TCP/IP address for the WebApp server. |
| dateTimeStamp | The date/time stamp for the error. Includes:
For example, if the date/time stamp is 20080401093043, then the error occurred on April 1, 2008, at 9:30:43 AM. |
| sessionIdentifier | The first six characters of the session identifier. |
You can use the error code to find the corresponding log file entries. To do this, click the Session Error Search tab.
In the Error code field, type the error code to use to find the log file.
On the General Search or Session Error Search tab, to display a list of log files, click Search Files. The log file list can include:
To download a log file from the Search Log Files page, click its Download link.
To view a log file from the search results on the General Search or Session Error Search tab, click its View link. The Filter Log Entries form displays.
If there are too many entries to display, then a notice displays at the top of the form. You will need to filter the entries.
To filter the file entries, you can use the following criteria:
| Session ID | The session identifier for the entry. |
| User login ID | The login name for the user associated with the entry. |
| Entry type | The type of entry. |
| Time window from | The time range for which to include entries. |
To filter the entries based on the criteria, click Filter Entries.
From the Filter Log Entries form, to download the filtered log file entries, click Download.