|
Siebel System Monitoring and Diagnostics Guide > Configuring Client-Side Logging >
About Client-Side Log Files
Log files for Siebel Business Applications record data for individual user or global session information for a specific Siebel Server and capture browser activity data that you can use for troubleshooting. The Siebel application stores these client-side logging files in a separate C:\SiebelLogs directory for each session. NOTE: Client-side logging applies only to Siebel CRM applications deployed using high interactivity.
The naming convention for client-side log files is: SiebelCL.<session_ID><number>.log
where:
- session_ID is the unique session ID number created for the user.
- number is an incremental integer that is dependent on a preset log file size.
For example, a resulting log filename might be: SiebelCL.ynFc7ujPpnG4.N.8tbIiLKBa7t3fSDpG-1GNdBJgNZw_.log
where:
- ynFc7ujPpnG4.N.8tbIiLKBa7t3fSDpG-1GNdBJgNZw is the session_ID.
- _ is an incremental integer.
If the size of a log file exceeds the preset log file size (as specified either at the server or client level), then a new log file is created by adding an incremental integer to the log filename as follows: SiebelCL.J1CWMStoyHrjkydKbJ2JmX2Zf32YnZa2Ep8wBE5i.jo_.03
SiebelCL.J1CWMStoyHrjkydKbJ2JmX2Zf32YnZa2Ep8wBE5i.jo_.02
SiebelCL.J1CWMStoyHrjkydKbJ2JmX2Zf32YnZa2Ep8wBE5i.jo_.01
where:
- The file with the 03 suffix is the most current.
- The file with the 01 suffix is the oldest.
For more information about:
Each client-side log file consists of a log file header and a log file detail as shown in Figure 2.
Figure 2. Sample Client-Side Log File
|
The Client-Side Log File Header
The format of the client-side log file header is: start_timestamp end_timestamp GMT_offset application_name computer_IP username session_ID IE_process_ID IE_thread_ID log_file_path product_version_build_lang
A sample log file header (as shown in Figure 2) might be: 2015-05-13 17:17:28 2015-05-14 12:06:34 -0700 Siebel Universal Agent 64.181.171.9 BCOOK ynFc7ujPpnG4.N.8tbIiLKBa7t3fSDpG-1GNdBJgNZw_ 4196 6080 d:\mySiebelLog\SiebelCL.ynFc7ujPpnG4.N.8tbIiLKBa7t3fSDpG-1GNdBJgNZw_.log 15.0 [20405....] LANG_INDEPENDENT
Table 37 provides sample data and a description of each element in the sample log file header.
Table 37. Sample Data in a Client-Side Log File Header
|
|
|
<start_timestamp> |
2015-05-13 17:17:28 |
The time the log file is created in YYYY-MM-DD HH:MM:SS format. |
<end_timestamp> |
2015-05-14 12:06:34 |
The time the client session ends and the log file stops being written in
YYYY-MM-DD HH:MM:SS format. |
<GMT_offset> |
-0700 |
Offset of the local time from Greenwich Mean Time (GMT) in the format ±HHMM. |
<application_name> |
Siebel Universal Agent |
The application to which this log file refers, in this instance, Siebel Call Center. |
<computer_IP> |
64.181.171.9 |
The IP address for the client computer. |
<username> |
BCOOK |
The name of the user logged in to the application. |
<session_ID> |
ynFc7ujPpnG4.N.8tbIiLKBa7t3fSDpG-1GNdBJgNZw_ |
A unique session number created for the user for this event. |
<IE_process_ID> |
4196 |
The operating system process ID for the Internet Explorer browser hosting the Siebel application. |
<IE_thread_ID> |
6080 |
The operating system ID for the Internet Explorer browser. |
<log_file_path> |
d:\mySiebelLog\SiebelCL.ynFc7ujPpnG4.N.8tbIiLKBa7t3fSDpG-1GNdBJgNZw_.log |
The directory path of the log file. |
<product_version_
build_lang> |
15.0 [20405....] LANG_INDEPENDENT |
Product version and language code that the client is running. |
Client-Side Log File Information
Figure 3 shows elements in the log file for the same sample log file (SiebelCL.ynFc7ujPpnG4.N.
8tbIiLKBa7t3fSDpG-1GNdBJgNZw_.log).
Figure 3. Sample Client-Side Log File Detail
|
The format for the client-side log file detail is: <trace_area><TAB><trace_category><TAB><numeric_category_level><TAB>
<SARM_operation_number><timestamp><TAB><source_file(line_number)>
<SPACE><logged_data><CRLF>
Table 38 provides sample data and a description of each element in the log file. The term CRLF is an abbreviation for a line terminator (carriage return and line feed).
Table 38. Sample Client-Side Log File Detail
|
|
|
<trace_area> |
TRACE_AREA_OM |
The functional area of the application writing the log file data. |
<trace_category> |
TRACE_INFO |
The textual name given to a log level. |
<SARM_operation_number> |
0 |
The click ID value that is captured by the SARM (Siebel Application Response Management) infrastructure. This value is the same value as the value captured in the component log files in the SARM files. You can use this value to compare between client and other log files. |
<timestamp> |
2015-05-13 17:17:28 |
The time the log data is written to the log file in YYYY-MM-DD HH:MM:SS format. |
<logged_data> |
axapp.cpp(236)CSS... |
The information written to the log file that provides contextual information about the application behavior, parameter values, and so on. |
About Trace Areas and Trace Categories with Log Levels
Each log entry in a client-side log file captures a trace area and trace category with the log level. The log entry identifies the functional area of the application writing the log file data and how detailed that data is. Trace Areas
Table 39 provides a description of each of the trace areas.
Table 39. Trace Areas for Client-Side Logging
|
|
TRCAREA_ATL |
Intercepted ATL (ActiveX template library) trace statements |
TRACEAREA_BRST |
Browser state (such as busy) |
TRACEAREA_BRWS |
Browser operations (such as minimum or maximum) |
TRACEAREA_CACHE |
Client-side string operation on a cache |
TRACEAREA_CLNT |
Messages from the client |
TRCAREA_CMDMGR |
Command manager |
TRCAREA_CUSTCTL |
Applications, custom controls |
TRCAREA_GENCTL |
Edit boxes, combination boxes |
TRACEAREA_JAVA |
Messages from JavaScript |
TRACEAREA_LAYOUT |
View layout operations |
TRCAREA_OM |
Area client object manager |
TRCAREA_POPUP |
Popup |
TRACEAREA_REQ |
Request sent to server |
TRACEAREA_RESP |
Response as a property set |
TRCAREA_UICOMP |
User interface components |
Trace Categories with Log Levels
Table 40 provides the various trace categories with the log-level values and a description of each. The higher the log level setting, the more detailed the information that is recorded as well as the larger the log file size. However, higher log-level settings might result in slower application performance. NOTE: Log levels are set internally in the application and cannot be configured.
Table 40. Trace Categories with Log Level Values for Client-Side Logging
|
|
|
TRACE_ERROR |
0 |
Describes the operations that fail. |
TRACE_WARNING |
1 |
Describes the operations that do not fail but might in the future if some condition is not changed. |
TRACE_INFO |
2 |
Describes the operations of interest to the person reviewing the log file, such as an interesting operation the application has performed. |
TRACE_DETAIL |
3 |
Describes the detailed operations performed. This event provides a larger volume of content when compared with the content provided by any of the other trace events. |
| 
