SiteScope User's Guide


Siebel Server Manager Monitor

The Siebel Server Manager Monitor uses the Siebel Server Manager client to monitor Object Manager components and task information on Siebel application servers.

Usage Guidelines

The following are several key requirements for using the Siebel Server Manager Monitor:

  1. The Siebel Server Manager client must be installed on the machine where SiteScope is running or accessible to the SiteScope machine. There are several options for how you can do this:
    1. Copy the necessary client libraries from the Siebel server and install them on the machine where SiteScope is running (recommended option).
    2. Enable the client on the Siebel server itself and create a remote server profile in SiteScope to access that server and the Siebel client on that server.
    3. Install and enable the client on a third remote server and create a remote server profile in SiteScope to access that server and the Siebel client on that server.
    4. For Windows networks, map the network drive where the Siebel client is installed to the SiteScope machine and use this in the Script Path.
  2. You will need to know the install path for the Server Manager client to be able to setup Siebel Server Manager monitors in SiteScope. If the client is installed on the machine where SiteScope is running, this will be the path on that machine. If the client is installed on a remote machine, you need to know the fully qualified path to the client executable relative to that machine.
  3. You need to know the name of the Siebel application(s) that are available in your network. For example, callcenter, sales, and so forth.
  4. You need to know the name or address of the Siebel Gateway server used by the Siebel applications you want to monitor. Ask your Siebel system administrator or consult the Siebel documentation for more information about the Gateway server name.
  5. You need to know the name or address of the Siebel Enterprise server used by the Siebel applications you want to monitor. Ask your Siebel system administrator or consult the Siebel documentation for more information.
  6. You need to know the user and password that SiteScope will use for logging into the Siebel server. This user must be granted Siebel Administrator responsibility on the Siebel server.
  7. You need to know the full path to the executable directory of the Siebel Server Manager Client relative to the machine it is installed on.
  8. Important: Finally, you need to make sure that the Siebel Server Manager Client's libraries are available to the Client.

    For SiteScope on UNIX/Linux - If the client libraries are installed locally, you will need to explicitly configure the LD_LIBRARY_PATH to include the directory containing the Siebel Server Manager Client's libraries (for example, /var/siebel/client/lib). If you are running the Siebel Server Manager Client locally on the SiteScope server, update the LD_LIBRARY_PATH line in the start-monitor script in the <SiteScope install path>/SiteScope/classes directory.

    If you are accessing the Siebel Server Manager Client on a remote server, you will need to have a remote UNIX server profile to connect to that server. You will need to set the LD_LIBRARY_PATH on that machine by using the Initialize Shell Environment field for the remote server configuration created in SiteScope. An example shell initialization command would look like the following:

    LD_LIBRARY_PATH=/var/siebel/client/lib;export LD_LIBRARY_PATH

    For SiteScope on Windows - If the client libraries are installed locally, you need to add a system variable called LD_LIBRARY_PATH that includes the path to the bin directory of the Siebel Client Manager.

    If you are accessing the Siebel Server Manager Client on a remote server, you will need to have a remote NT server profile to connect to that server (NetBIOS connections ONLY). You will need to enter the full path to the Siebel Server Manager executable directory relative to the server chosen in the Script Path field on the Choose Server screen.

Completing the Siebel Server Manager Monitor Form

To display the Siebel Server Manager Monitor Form, either click the Edit link for an existing Siebel Server Manager Monitor in a monitor table, or click the Add a new Monitor to this Group link on a group's detail page and click the Add Siebel Server Manager Monitor link. Complete the items on the Siebel Server Manager Monitor form as follows. When the required items are complete, click the Add Monitor button.

Server
Click the choose server link to enter the server information needed to connect to the Web plug-in server stats page for the Siebel application. The Choose Server screen is displayed. Complete the form as follows:
  • Server - The Remote NT or Remote UNIX machine where the Server Manager (srvrmgr) script is installed. Method of connection is either SSH or Telnet. For NetBIOS choose "this server" and map the drive of the remote server to the SiteScope machine.
  • Application Server - The Siebel server name or address.
  • Gateway Server - Gateway server name or address.
  • Enterprise Server - Enterprise server name or address.
  • Username - The username for the Siebel Server Manager client. Note that this user must have Siebel Administrator Responsibility privileges to retrieve metrics via the Siebel Server Manager component.
  • Password - The password for the Siebel Server Manager client.
  • Script Path - The full path to the Siebel Server Manager executable directory relative to the Server chosen above. For example, E:\sea704\client\BIN. On Windows networks, if you have mapped the remote drive to the SiteScope machine, enter the script path using the mapped drive path.

Counters
Click on this link to choose the Siebel server statistics to be used as counters. The Choose Counters page presents the counters available in an expandable tree format. Use the plus sign or minus sign features to expand or collapse the tree. Click the check box next to the counters you want to monitor. You can to select between one to ten counters to monitor with a single monitor instance. The following are typical of the counters available for the Siebel Server Manager Monitor:

  • Server Stats/SiteScopeMSP/Avg SQL Execute Time
  • Server Stats/SiteScopeMSP/No. of tasks Running
  • Server Stats/SiteScopeMSP/Total Tasks
  • Server Stats/SiteScopeMSP/Number of SQL Executes
  • Server Stats/SiteScopeMSP/CPU Time
  • Server Stats/SiteScopeMSP/Average Response Time
  • Server Stats/SiteScopeMSP/Average Connect Time
  • Server Stats/SiteScopeMSP/Total Response Time
  • Component Stats/System Management/File System Manager/Elapsed Time
  • Component Stats/Siebel Sales/Sales Object Manager/Average Connect Time
  • Component Stats/Siebel Call Center/Service Object Manager/CPU Time
  • Component Groups/Siebel Call Center/CG_RUN_STATE
  • Component Objects/Siebel Call Center/Call Center Object Manager/CP_NUM_RUN
  • Component Objects/Siebel Call Center/Call Center Object Manager/CP_MAX_TASK

Update every
Select how often the monitor should check the Database server. The default interval is to run or update the monitor once every 10 minutes. Use the drop-down list to the right of the text box to specify another update interval in increments of seconds, minutes, hours, or days. The update interval must be 15 seconds or longer.

Title
Enter a title text for this monitor. This text is displayed in the group detail page, in report titles, and other places in the SiteScope interface. If you do not enter a title text, SiteScope will create a title based on the host, server, or URL being monitored.

Advanced Options

The Advanced Options section presents a number of ways to customize monitor behavior and display. Use this section to customize error and warning thresholds, disable the monitor, set monitor-to-monitor dependencies, customize display options, and enter other monitor specific settings required for special infrastructure environments. The options for this monitor type are described below. Complete the entries as needed and click the Add or Update button to save the settings.

Disable
Check this box to temporarily disable this monitor and any associated alerts. To enable the monitor again, clear the box.

Timeout
Enter the total time, in seconds, to wait for a successful test run. The time, in seconds, to wait for a success test run. After the defined timeout the monitor will stop running with an error timeout, and the browser and all the other processes created by running the monitor will be killed.

Detailed errors logging
Check this box if you want SiteScope to include detailed errors in the state string and in the log file in case of failure. In any case of failure, SiteScope will keep the log file of all the script execution, and a link to this log file will be available from the state string of the monitor and from the reports for future reference.

Process HTTP failure as error
Check this box if you want SiteScope to process every HTTP error (such as server not found) as an error in the monitor run. Note that choosing this option will fail the monitor and the transaction in which it appeared, even if a single .gif file is missing. By default HTTP errors counts as warning.

Process Checkpoint failure as warning
Check this box if you want SiteScope to process checkpoint failure as an error. Checkpoints are verification points that can be added using the ALT Recorder, and enable you to verify the content of a page. By default checkpoint failures are counted as errors.

Ignore warnings
Check this box if you want SiteScope to ignore all warnings appeared during the script execution. Note that choosing this option will cause all the Warnings thresholds to be ignored. By default SiteScope does not ignore warnings.

Verify Error
Check this box if you want SiteScope to automatically run this monitor again if it detects an error. When an error is detected, the monitor will immediately be scheduled to run again once.

Note: In order to change the run frequency of this monitor when an error is detected, use the Update every (on errors) option below.

Note: The status returned by the Verify Error run of the monitor will replace the status of the originally scheduled run that detected an error. This may cause the loss of important performance data if the data from the verify run is different than the initial error status.

Warning: Use of this option across many monitor instances may result in significant monitoring delays in the case that multiple monitors are rescheduled to verify errors at the same time.

Update Every (on error)
You use this option to set a new monitoring interval for monitors that have registered an error condition. For example, you may want SiteScope to monitor this item every 10 minutes normally, but as often as every 2 minutes if an error has been detected. Note that this increased scheduling will also affect the number of alerts generated by this monitor.

Schedule
By default, SiteScope monitors are enabled every day of the week. You may, however, schedule your monitors to run only on certain days or on a fixed schedule. Click the Edit schedule link to create or edit a monitor schedule. For more information about working with monitor schedules, see the section on Schedule Preferences for Monitoring.

Monitor Description
Enter additional information about this monitor that will make it easy to identify. The Monitor Description can include HTML tags such as the <BR> <HR>, and <B> tags to control display format and style. The description will appear on the Monitor Detail page.

Report Description
Enter an optional description for this monitor that will make it easier to understand what the monitor does. For example, network traffic or main server response time. This description will be displayed on with each bar chart and graph in Management Reports and appended to the tool-tip displayed when you pass the mouse cursor over the status icon for this monitor on the monitor detail page.

Depends On
To make the running of this monitor dependent on the status of another monitor or monitor group, use the drop-down list to select the monitor on which this monitor is dependent. Select None to remove any dependency.

Depends Condition
If you choose to make the running of this monitor dependent on the status of another monitor, select the status condition that the other monitor or monitor group should have in order for the current monitor to run normally. The current monitor will be run normally as long as the monitor on which it depends reports the condition selected in this option.

List Order
By default, new monitors are listed last on the Monitor Detail page. You may use this drop-down list to choose a different placement for this monitor.

Setting Monitor Status Thresholds

SiteScope Application Monitors allow you to set multiple threshold conditions to determine the status reported by each monitor. The individual conditions are combined as logical OR relationships so that when one or more of the conditions (for example any of the conditions for Error if) are met the monitor status is set to the applicable condition. If multiple conditions are met for more than one status condition (such as conditions for both error and for warning), the status for the monitor is set to the highest valued condition. Thus a match of an error condition and a warning condition would be reported as an error status, error being the highest value, warning the next highest and good the lowest value.

Error if
Use one or more of the selection boxes in this item to define one or more error conditions for this monitor. Use the drop-down lists in this item to change error threshold(s) relative to the counters you have selected to check with this monitor. After choosing a counter or parameter, use the comparison operator drop-down list to specify an error threshold such as: >= (greater than or equal to), != (not equal to), or < (less than) and enter a comparison value in the box provided. Comparison values should be entered as whole numbers.

Warning if
Use one or more of the selection boxes in this item to define one or more warning conditions for this monitor. Use the drop-down lists in this item to change warning threshold(s) relative to the counters you have selected to check with this monitor. Set these values relative to those you set for the error threshold in the Error if item.

Good if
You can set this monitor to return a good status for certain conditions. You may define those conditions here. Complete this item as you would for the Error if and Warning if items.