1. Monitoring and Diagnostics Guide
  2. What's New in This Release

2Configuring Siebel Application Interface Logging and Monitoring

About Siebel Application Interface Logging

Siebel Application Interface writes several different types of logs. These logs include the following:

  • UI.log for user applications

  • EAI.log for EAI applications

  • siebeljbs.log for 64-bit Java business service executions

  • siebel-outbound.log for outbound SHA-2

  • CommonLoggerLog.log for some common events like startup and shutdown of Siebel Application Interface

The logs noted here are written in the SiebelAI_Root\log directory. Standard application container logs are created in the same directory.

Configuring Siebel Application Interface Logging

For Siebel Application Interface, log levels are configured in the Application Interface profile. For more information, see the chapter about configuring Siebel CRM server modules in the Siebel Installation Guide for the operating system you are using.

About Siebel Application Interface Monitoring

Monitor the Siebel Application Interface by configuring and reading the Siebel Application Interface statistics page. This HTML page provides current information about the operations and communications of the Siebel Application Interface, which allows system administrators to have a better understanding of the use of this module. Each of the sections of the statistics page lists measurable objects, their values, mean values, and standard deviations.

Caution: As the Siebel Application Interface statistics page provides sensitive information about the type of requests running and potentially active sessions, it is strongly recommended that this page be protected with an authentication mechanism, such as from a third-party provider.

Configuring the Siebel Application Interface Statistics Page

The Siebel Application Interface statistics page is configured when you configure applications on the Siebel Application Interface using Siebel Management Console. This page is located at the following URL:

https://ApplicationInterfaceHost:Port/siebel/stats

For more information about specifying the Siebel Application Interface statistics page and related settings when you configure the Siebel Application Interface profile, see the Siebel Installation Guide for the operating system you are using.

You can specify whether statistics are gathered on current sessions and then reported to the statistics page. If Monitor Sessions is enabled, then, when sessions are created, they are entered into the statistical repository and appear on the application’s Siebel Application Interface statistics page. This setting allows system administrators to determine who is logged onto the system at any given time, and to determine the session ID with a given user in a non-debug log level. However, performance is slightly degraded by using this feature. If Monitor Sessions is not enabled, then sessions are not monitored by the statistical repository and do not appear in an application’s statistics page.

Accessing the Siebel Application Interface Statistics Page

The Siebel Application Interface statistics page is generated by the Siebel Application Interface. To access the Siebel Application Interface statistics page, enter a URL like the following in a Web browser:

https://ApplicationInterfaceHost:Port/siebel/stats

When accessing the Siebel Application Interface statistics page URL, additional parameters can be appended to the URL, which modify the display and content of the page.

Statistics Page Verbosity Option. This option allows the user to dictate the amount of information that is to appear in Siebel Application Interface statistics page. There are three settings as shown in the following table.

Verbose Parameter Setting Description

Verbose=Low

Default value if not present. Displays only system and application-level statistics.

Verbose=Medium

Displays the low-setting information, plus the lock statistics.

Verbose=High

Displays the medium-setting information, plus currently active operations to the Siebel Server.

Statistics Page Reset Option. This option allows the user to dictate whether the statistics are reset after viewing. There are two settings as shown in the following table.

Verbose Parameter Setting Description

Reset=True

Resets noncounter and current operational statistics.

Reset=False

Default value if not present. Does not reset current operational statistics.

Examples of the Siebel Application Interface statistics page request with parameters:

  • https://ApplicationInterfaceHost:Port/siebel/stats?Verbose=High&Reset=True

    This request displays the System Stats, Applications, Current Sessions, Locks, and Current Operations Processing statistical categories and then resets noncounter and current operational statistics.

  • https://ApplicationInterfaceHost:Port/siebel/stats?Reset=True

    This request displays the System Stats and Applications statistical categories and then resets noncounter and current operations statistics.

Siebel Application Interface Statistics Page

The individual events and objects measured on the Siebel Application Interface statistics page are described in the following list. For examples of these metrics, see Example of Siebel Application Interface Statistics Page.

Open Session Time. This event reflects the total amount of time it took to open a session. In the general stats section, the count is the number of times a session was opened and the mean reflects the average time it took to open a session.

Response Time (waiting for service event). This event measures the time it takes to receive a callback response from the Siebel server. This event functions with CTI and internal login callbacks. A callback is a mechanism used by the Siebel Server to initiate communication with the Siebel Application Interface.

Close Session Time. This event reflects the amount of time it takes to close a session. Closing the session might involve signaling to the session manager to close the session. The session manager might or might not close the TCP/IP connection.

Request Time (waiting for service method to process). This event is the amount of time it takes to submit a request to the Siebel Server and to get a response back. For example, if the user (on the browser) clicked on a button, then the Siebel Application Interface receives the request and invokes a service on the Siebel Server. The value for Request Time is the total amount of time for invoking that service.

Applications. This section displays information about the various applications, for example, session life span and number of attempts to use the application.

Current Sessions. This section contains information about the current active sessions open. The parameter SessionMonitor must be set to True for this to take effect (see Configuring the Siebel Application Interface Statistics Page for more information about SessionMonitor). If verbose mode is used, then this section also displays the anonymous sessions (see Accessing the Siebel Application Interface Statistics Page for more information about verbose mode).

Current Operations Processing. Use the information in the following table when troubleshooting a process that might have stopped responding.

The Current Operations Processing section contains a table that shows current requests that are in progress. The following table shows the operations that are running and the duration of each operation (in seconds). Requests highlighted in bold have been running for more than 10 seconds. A request highlighted in bold with a large duration value indicates that this request might not be responding. If a request never completes, then it has effectively stopped responding.

Operation Duration

<server>://172.20.232.19:2320/siebel/SCCObjMgr/!7.fb8.ddde. <snip>

3888.0282

<server>://172.20.232.19:2320/siebel/SCCObjMgr/!8.f54.df75.3c07ef90 <snip>

20.8209

<server>://172.20.232.19:2320/siebel/SCCObjMgr/!8.f54.df75.3c07ef90 <snip>

0.2796

The following table provides descriptions of some of the Siebel Application Interface statistics and is followed with the definition of those statistics.

Type of Statistic
Statistic General Frequency Description

Count

Yes

No

Accumulative count of the events

Mean

Yes

No

Average value for the event

No

Yes

Average period for which one such event occurs (in seconds)

Standard deviation

Yes

No

Standard deviation for the event

No

Yes

Standard deviation (in seconds)

Statistics results can vary depending on the session type. For example, for an anonymous session requested from the pool event type, the statistics provide the following information:

  • General statistics count. The accumulative count of the anonymous session requests.

  • General statistics mean. The average value for anonymous session requests (the value is 1 or greater).

  • General statistics standard deviation. The standard deviation for anonymous session requests (the value is zero [0] or greater).

  • Frequency mean. The average period between anonymous session requests in seconds.

  • Frequency stddev. The standard deviation in seconds.

However, for an open session time event type, the statistics provide the following information:

  • General statistics count. The accumulative open session times.

  • General statistics mean. The average value for an open session time.

  • General statistics standard deviation. The standard deviation for an open session time.

  • Frequency mean. The average period between open session events in seconds.

  • Frequency standard deviation. The standard deviation in seconds.

The next topic, Example of Siebel Application Interface Statistics Page, provides examples that show how these statistics might occur with different types of events.

Example of Siebel Application Interface Statistics Page

A sample Siebel Application Interface statistics page is reproduced in the tables in this topic. The information contained in these tables encompasses one Siebel Application Interface statistics page.

The following table shows sample system statistics.

Event Value (Seconds) General Statistics (Count, Mean, Standard Deviation) Frequency (Mean, Standard Deviation)

Open Session Time

191.6682

12

15.9723

34.4210

61.9689

128.9318

Response Time (waiting for service event)

0.0000

0

0.0000

0.0000

0.0000

0.0000

Close Session Time

0.0000

0

0.0000

0.0000

0.0000

0.0000

Request Time (waiting for service method to process)

349.9513

23

15.2153

70.4652

3374.4503

16020.5422

The following table shows sample current sessions.

Event Total Time (Seconds) General Statistics (Count, Mean, Standard Deviation) Frequency (Mean, Standard Deviation)

siebel://test:2320/siebel/objmgr/test/!1.64c.14.3bb0e99fuser0

3.9228

4

0.9807

0.8953

85.9297

168.6426

siebel://test:2320/siebel/objmgr/test/!9.34b.1fe.3bbf349fuser1

338.4631

9

37.6070

112.8092

59.4458

116.0594

siebel://test:2320/siebel/objmgr/test/!1.56.1ef.4c0a0e99fuser2

3.3424

3

1.1141

0.8227

25665.0354

44450.4096

The following table shows a sample current operations processing.

Operation Duration (Seconds)

NewAnonSession_00000022_499

0.9581

Open Session Time_00000023_499

0.9580