SiteScope User's Guide

iPlanet Server Monitor

The SiteScope iPlanet Server Monitor allows you to monitor the availability of SunONE/iPlanet and Netscape servers. The error and warning thresholds for the monitor can be set on as many as ten Netscape server performance statistics or HTTP response codes.

Note: The SiteScope iPlanet Server Monitor is formerly known as the Netscape Server Monitor. Several file, name, and performance counter changes have been made to reflect the changes in the server product name and capabilities of the monitor.

Usage Guidelines

The iPlanet Server Monitor allows you to monitor the content of server administration pages for iPlanet and Netscape servers. You can monitor multiple parameters or counters with a single monitor instance. This allows you to watch server loading for performance, availability, and capacity planning. Create a separate monitor instance for each server you're running.

The following are requirements for using the iPlanet Server Monitor:

To monitor Current Activity statistics for iPlanet 4.1 servers:
1. You will need to know the username and password to access the iPlanet administrative server page. The URL for the main administrative page normally has the form of:
  http://serveraddress:adminport/https-admserv/bin/index
2. Identify the virtual server instance name you want to monitor. This should be available in the drop-down box to the right of the Manage button. Enter it in the place of virtualserveraddressname in the URL (see below).
3. Set up monitor using iPlanet 4.1 current activity counters using the URL of the following form:
  http://serveraddress:adminport/https-virtualserveraddressname/bin/sitemon?doit:
To monitor performance dump statistics for iPlanet 4.1 servers:
1. Modify the obj.conf file for each virtual server instance you want to monitor adding the line to enable perf dump. The conf entry normally has the form of:
  <Object ppath="path/Netscape/Server4/docs/.perf"> Service fn=service-dump </Object>
2. Restart the server(s)
3. Access the performance dump page using the URL of the form: http://serveraddress:http_port/.perf
4. Set up the iPlanet Server Monitor using iPlanet 4.1 performance dump counters (see below)
To monitor server statistics for iPlanet 6.0 servers using HTTP:
1. You will need to know the username and password to access the iPlanet administrative server page. The URL for the main administrative page normally has the form of:
  http://serveraddress:adminport/https-admserv/bin/index
2. Indentify the specific server instance names as shown in the drop-down box next to the Manage button. the server instance names are used as the virtualserveraddressname the URL for monitoring that server instance. The URL needed to monitor the server statistics normally has the form of;
  http://serveraddress:adminport/https-virtualserveraddressname/bin/instance-app/pageStats.jsp?pollInterval=15&vsname=All
  where pageStats is replaced with a specific statistics page name as outlined below.
  Note: For the value for vsname (virtual server name) you can replace All with a specific virtualserveraddressname to monitor specific server instances. For example:
  http://serveraddress:adminport/https-virtualserveraddressname/bin/instance-app/pageStats.jsp?pollInterval=15&vsname=virtualserveraddressname
  - To monitor virtual server activity statistics substitute virtualServerStats for pageStats.
  - To monitor server connection status statistics substitute connectionStats for pageStats.
  - To monitor server DNS statistics for iPlanet 6.0 servers substitute dnsStats for pageStats.
  - To monitor Keep-Alive statistics substitute keepAliveStats for pageStats.

Completing the iPlanet Server Monitor Form

To display the iPlanet Server Monitor Form, either click the Edit link for an existing iPlanet Server Monitor in a monitor table, or click the add a Monitor link on a group's detail page and choose the "Add iPlanet Server Monitor" link.

Complete the items on the iPlanet Server Monitor Form as follows. When the required items are complete, click the Add Monitor button.

Counters

Choose the server performance parameters or counters you want to check with this monitor. The text box to the right of this item displays those currently selected for this monitor. Use the choose counters link to bring up the counters selection screen. Check or clear the check boxes on the Choose Counters screen to select between one to ten counters to monitor on this server.

Note: Select only those counters that are applicable to the server version you want to monitor

Note: Do not edit the order of the counters in the selected counter text box. The counters must be maintained in the order they appear in the choose counter selection page.

The SunONE/iPlanet 4.1 performance parameters or counters available for the iPlanet Server Monitor include:

For current server activity:
1. Bytes transferred
2. Total requests
3. Bad requests
4. 200 - number of successful transactions processed by the server since the last server restart.
5. 2xx - The number of the server handles status codes in the 200 to 299 range since the last server restart.
6. 302 - The number of requests with a status of "found".
7. 304 - The number of requests with a status of "not modified" in response to conditional GET requests.
8. 3xx - The number of server handles status codes in the 300 to 399 range since the last server restart.
9. 401 - The number of unauthorized requests handled by the server since the last server restart.
10. 403 - The number of forbidden requests handled by the server since the last server restart.
11. 4xx - The number of server handles status codes in the 400 to 499 range since the last server restart. This includes code 404 which is a status of "not found"
12. 5xx - The number of server handles status codes in the 500 to 599 range since the last server restart. This includes code 500 which indicates a server internal error.
13. xxx - all three digit HTTP response codes
For server performance dump:
1. Address
2. ActiveThreads
3. WaitingThreads
4. BusyThreads
5. Thread limits
6. Total Sessions
7. KeepAliveCount
8. KeepAliveHits
9. KeepAliveFlushes
10. KeepAliveTimeout
11. enabled - Indicated the state of the Cache feature
12. CacheEntries
13. Hit Ratio
14. pollInterval
15. NativePool:
16. Idle/Peak/Limit - Returns numbers expressed in the format of nn/nn/nn
17. Work queue length/Peak/Limit - Returns numbers expressed in the format of nn/nn/nn

The iPlanet 6.0 server performance parameters or counters available for the iPlanet Server Monitor include:

For Virtual Server statistics (virtualServerStats.jsp):
1. Total Number Of Requests
2. Number Of Bytes Received
3. Number Of Bytes Sent
4. Number Of Virtual Servers
5. 200 - number of successful transactions processed by the server since the last server restart.
6. 2xx - The number of the server handles status codes in the 200 to 299 range since the last server restart.
7. 302 - The number of requests with a status of "found".
8. 304 - The number of requests with a status of "not modified" in response to conditional GET requests.
9. 3xx - The number of server handles status codes in the 300 to 399 range since the last server restart.
10. 401 - The number of unauthorized requests handled by the server since the last server restart.
11. 403 - The number of forbidden requests handled by the server since the last server restart.
12. 404 - The number of page not found requests handled by the server since the last server restart.
13. 4xx - The number of server handles status codes in the 400 to 499 range since the last server restart. This includes code 404 which is a status of "not found"
14. 5xx - The number of server handles status codes in the 500 to 599 range since the last server restart. This includes code 500 which indicates a server internal error.
15. Other - all three digit HTTP response codes
For Keep-Alive statistics (keepAliveStats.jsp):
1. Maximum Keep-Alive Connections
2. Keep-Alive Timeout
3. Number Of Processes
4. Keep-Alive Hits
5. Keep-Alive Flushes
6. Keep-Alive Refusals
7. Keep-Alive Timeouts
For server DNS statistics (dnsStats.jsp):
1. Maximum DNS Cache Entries
2. Number Of Processes
3. DNS Cache Hits
4. DNS Cache Misses
For Cache statistics (cacheStats.jsp):
1. Maximum Cache Age \(seconds\)
2. Maximum Heap Cache Size
3. Maximum Memory Cache Map Size
4. Number Of Processes
5. Cache Hits
6. Cache Misses
7. Info Cache Hits
8. Info Cache Misses
9. Content Cache Hits
10. Content Cache Misses
For Connection statistics (connectionStats.jsp):
1. Total Number Of Connections
2. Maximum Number Of Queued Connections
3. Peak Number Of Queued Connections
4. Current Number Of Queued Connections
5. Number Of Processes

URL

Choose the URL you want to verify with this monitor. This URL should be the URL to the applicable server monitor statistics web page for the server version you want to monitor. For iPlanet 4.1 servers this usually has the form of http://servername:adminport/https-serveraddress/bin/sitemon?doit. For iPlanet 6.0 servers, the URL of the monitor statistics web page has the form http://servername:adminport/https-instanceserveraddress/bin/instance-app/pageStats.jsp?pollInterval=15&vsname=All where pageStats.jsp is replaced with the file reference for the specific statistics page you want to monitor (see the list of counters above).

Note: The servername:port and serveraddress are not necessarily identical depending on if you access the administrator server pages locally or remotely. The SiteScope iPlanet Server Monitor generally needs to be configured using the full serveraddress and not the https-admserv syntax. Normally you can find the serveraddress in the Select a Server box on the main administration web page.

Note: (Recommended for Advanced Users Only) The iPlanet Server Monitor can be used to monitor other server products in the SunONE product line that make their performance statistics available via an server monitor statistics web page. In order to monitor other products you will need to know the URL of the access log or administration web page for that product version. You will need to modify the regular expression in the _netscapeRegExp= entry of the SiteScope master.config file and add any additional counter strings to the SiteScope/templates.applications/counters.iplanet file to extract the applicable values from the administration logs.

Update every

Enter how frequently the monitor should access the URL entered above. The drop-down list to the right of the text box lets you specify time increments of seconds, minutes, hours, or days. You must specify a time increment of at least 15 seconds.

Note: Depending on the activity on the server, the time to build the server monitor statistics web page may take more than 15 seconds. You should test the monitor with an Update value of several minutes to ensure that the server can build and serve the server monitor statistics web page before the SiteScope monitor is scheduled to run again.

Title (Optional)

Enter a name for this monitor. This name appears in the Name text box on the monitor table when you open the group's detail page. If you don't enter a name, a default name will be created.

Advanced Options

The advanced options give you the ability to customize error and warning thresholds. If you choose not to set them, SiteScope will use pre-set defaults if available. If a default is not available, SiteScope will not be able to utilize the condition.

Disable

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

Timeout

The number of seconds that the monitor should wait for a response from the server before timing-out. Once this time period passes, the monitor will log an error and report an error status.

Note: Depending on the activity on the server, the time to build the server monitor statistics web page may take more than 15 seconds. You should test the monitor with an Timeout value of more than 60 seconds to ensure that the server can build and serve the server monitor statistics web page before the SiteScope monitor is scheduled to run again.

HTTP Proxy

Optionally, a proxy server can be used to access the server. Enter the domain name and port of an HTTP Proxy Server.

Authorization User Name

If the server you want to monitor requires a name and password for access, enter the name in this box.

Authorization Password

If the server you want to monitor requires a name and password for access, enter the password in this box.

NT Challenge Response

Check this box if you want SiteScope to use Window's NT Challenge Response authorization when accessing the server.

Proxy Server User Name

If the proxy server requires a name and password to access the server, enter the name here. Technical note: your proxy server must support Proxy-Authenticate for these options to function.

Proxy Server Password

If the proxy server requires a name and password to access the server, enter the password here. Technical note: your proxy server must support Proxy-Authenticate for these options to function.

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)

This options allows you 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 (Optional)

By default, SiteScope's 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. Choose the Edit schedule link to create or edit a monitor schedule. For information about creating schedules, read these instructions.

Monitor Description (Optional)

Enter additional information about this monitor. 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 (Optional)

Enter a description for this monitor that will make it easier to understand what this monitor does. The description will appear on Management Reports and on the info pop-up for a monitor.

Depends On (Optional)

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 or group on which this monitor is dependent. Select None to remove any dependency.

Depends Condition (Optional)

If you choose to make the running of this monitor dependent on the status of another monitor, choose 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 or group on which it depends reports the condition selected in this option.

List Order (Optional)

By default, new monitors are listed last on the Monitor Detail page. You can 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 these items 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 these items to change warning threshold(s) relative to the counters you have selected to check with this monitor. Set these value 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.