 |  |  |
SiteScope Reference Guide
SiteScope Configuration Settings |
SiteScope is designed for versatility and flexibility. Some environments and customizations require changes to SiteScope settings. You can customize the behavior and appearance of SiteScope by adding or modifying SiteScope configuration settings.
This chapter describes:
- About SiteScope Configuration Settings
- Working with Configuration Settings
- Listing of Configuration Settings
About SiteScope Configuration Settings |
You can adapt SiteScope to work with many environments by settings available in the user interface. Some monitoring environments may require you to change how SiteScope interacts with servers and systems in the infrastructure. Some optional settings may not be available by controls in the normal SiteScope interface. You can change some SiteScope behavior by modifying the applicable configuration settings.
Configuration settings for SiteScope are stored in a number of files found in the installation directory. The following table lists the files and a general description of the what settings are applicable to that file.
|
File |
Description |
| master.config |
Main configuration settings controlling SiteScope function, behavior, and display. |
| multi.config |
Configuration settings controlling SiteScope Multi-view display. |
| users.config |
Configuration settings controlling login user profiles. |
| health.config |
Configuration settings controlling SiteScope health monitoring. |
| history.config |
Configuration settings controlling login user profiles. |
| <filename>.mg |
Monitor Group files created by the user. These configuration files contain settings for individual monitors and they group in which they are contained. |
Most of the settings described in this chapter are stored in and only applicable to the master.config file. Some of the settings, however, can also be added to individual monitor group files.
The following sections describe the entries that are normally found in or may be added to SiteScope configuration files. The format, purpose, and contents of the SiteScope configuration settings is described.
Working with Configuration Settings |
The configuration settings for SiteScope are stored as text files in the SiteScope\groups directory. These configuration settings are essential to the operation of the SiteScope application and to the monitoring, alerting, and recording functionality.
Caution: Mercury Interactive strongly recommends that you make changes to SiteScope settings using the Web browser interface. You should only make changes manually to the configuration settings if you require functionality that can not be enabled by options presented in the product interface.
Caution: When you make changes to the SiteScope configuration files directly with a text editor, it is possible to make format mistakes in the files that can stop SiteScope from functioning. Before making direct modifications to any SiteScope configuration files, you should make a complete backup of the SiteScope\groups directory.
When you first install SiteScope, the master.config file is empty. Whenever SiteScope starts, it looks at the default settings contained in classes\default.config and copies any new default settings into master.config.
All the configuration files share a common format. A file is made up of several records and a line starting with the # character is used as a record separator. Within a record, each line specifies a single value using a name=value format.
As noted, most of the settings are used in the master.config. Some settings can be used the header section of a monitor group file (*.mg file), or in the frame for an individual monitor within an *.mg file.
The format of the monitor group files is similar to the format of the master.config file except that the file is divided into sections known as frames. Monitor group files have a header frame and one or more other frames depending on the number of individual monitors or subgroups associated with the monitor group. The header frame and each other frame are separated by a line preceded with a # symbol. You add an applicable configuration setting to a monitor group file or to a monitor frame to reduce the scope for which the setting is effective.
If you want to modify settings that are already defined in the configuration files, you should use the forms provided in the SiteScope interface to create or modify the configuration you want and then inspect the corresponding configuration text files to view the configuration created by the SiteScope application. You can then make more changes manually.
Listing of Configuration Settings |
This section lists many of the configuration settings that are used or may be added to SiteScope.
Global Settings
The following global settings are found in the master.config file.
|
Key |
Description |
| _license |
The license number for this copy of SiteScope.The license number is a setting required by SiteScope that does not have a default value. Without a license number SiteScope will shut down after the evaluation period. |
Controlling Browser Access to SiteScope
The following settings can be used to control user access to SiteScope.
|
Key |
Description |
| _httpPort |
The preferred port used by the internal Web server. If you set this value to be blank the SiteScope internal Web server will be disabled. The default value is:8888 |
| _adminUsername |
The login name for the SiteScope administrator. |
| _adminPassword |
The login password for the SiteScope administrator. This value will normally be encrypted. |
| _adminExpireDays |
The number of days for which the login password for the SiteScope administrator will be valid. Used in combinaton with _adminChangedDate. |
| _adminChangedDate |
The most recent date when the login password for the SiteScope administrator was changed. Used in combinaton with _adminExpireDays. |
| _adminMinimumLength |
Sets the minimum length, in characters, for the SiteScope administrator login password. |
| _adminRedirectFile |
This option is used to specify an alternate location for the default SiteScope admin URL. The default file and location is http://SiteScopeInstallPath:8888/SiteScope/admin.htm. If present, SiteScope reads the value of this setting and copies the default admin file to the location specified. The value must be a full path name. |
| _adminRequireAlpha |
When set to true, requires that the login password for the SiteScope administrator include one or more alphabetic characters as part of the password. This prevents the use of a password such as 12345 |
| _adminRequireNumber |
When set to true, requires that the password for the SiteScope administrator include one or more numerals as part of the password. |
| _adminRequirePunctuation |
When set to true, requires that the password for the SiteScope administrator include one or more punctuation marks as part of the password. |
| _authorizedIP |
The IP address or addresses allowed to access SiteScope. If no IP address is specified, users may access SiteScope regardless of IP address. |
| _userUsername |
The login name for read-only user access to SiteScope. |
| _httpAdminRealm |
The realm of the SiteScope Administrator when authorizing. By default, this is SiteScope Administrator. |
| _httpUserRealm |
The realm of the SiteScope User when authorizing. By default, this is SiteScope User. |
| _httpSecureKeystorePassword |
The password for the SSL keystore file used when restricting access to SiteScope to HTTPS. |
| _httpSecureKeyPassword |
The password for the SSL certificate used when restricting access to SiteScope to HTTPS. |
| _httpSecurePort |
The server port number used when restricting access to SiteScope to HTTPS. By default, this should be 8899 |
| _disableLoginPage |
Set this equal to true to disable the login page method for accessing SiteScope (that is, page not dialog). Delete this variable to enable the login page. |
| _disableLoginChangePassword |
Set this equal to true to disable a user's ability to change his/her password. Delete this variable to enable password changing. |
| _ldapAuthenticationCaching |
Enabled caching of LDAP authentication so that SiteScope will only need to authenticate once per session instead of for each page request. This is useful if LDAP is being used to authenticate access to the SiteScope service. The default value is:true |
| _ldapCacheExpirationInSecs |
Number of seconds before the LDAP authentication cache will expire. The default value is60. This is useful if LDAP is being used to authenticate access to the SiteScope interface. This only takes effect if the _ldapAuthenticationCaching is set to true. |
| _userPassword |
The login password for read-only user access. |
Customizing the Main SiteScope Interface Display
The following settings can be used to change the display of the SiteScope Web browser interface:
|
Key |
Description |
| _progressRefreshRate |
The interval, in seconds, at which the Progress Report will be automatically refreshed by SiteScope. The default value is:20 |
| _mainRefreshRate |
The interval, in seconds, at which the main SiteScope page will be automatically refreshed by SiteScope. The default value is:60 |
| _groupRefreshRate |
The interval, in seconds, at which SiteScope group pages will be automatically refreshed by SiteScope. The default value is:60 |
| _httpCharSet |
Use this to explicitly set the character set returned to client Web browsers. By default, no character set is specified. |
| _prettyDateCustomPattern |
Use this to set the date format used in the SiteScope interface, alerts, and reports. The syntax for this setting must use a valid Java date format. |
| _userEnableRefresh |
Used to show or hide the Refresh button or link on group pages for users. Set this to true to enable the Refresh button. |
| _userHideMoreColumn |
Used to show or hide the More column link on group pages for users. Set this to true to enable the More link. |
| _errorInsertHTML |
HTML that is inserted at the bottom of any webpage that shows an error, including the SiteScope Panel, group Detail, Browse Monitors, and Multi-view windows. This can be any text and HTML mark-up. You can use this to insert a sound file using HTML mark-up. For example, <embed src="/SiteScope /templates.sound /Alarm.au" autoplay=true controller=false>. |
| _warningInsertHTML |
Works like the _errorInsertHML, except it is used for warning status. |
| _goodInsertHTML |
Works like the _errorInsertHML, except for OK status. |
| _maxWordLength |
Maximum number of characters to span before inserting a space into a group name on the main page gauge. This allows the browser to wrap to the next line. It affects the display of the group name only. The default value is:8.
|
| _maxNumberGroupNameLines |
Maximum number of lines to display for group name in main page gauge. The default value is:2.
|
| _mainGaugesPerRow |
Specifies how many rows will be used when displaying the gauges on the main page. This value can also be set using the General Preferences page. The default value is:3 |
| _noHttpAccessDuringInitialization |
If the value of this setting is blank this will disable the display of the "SiteScope Starting" page. If this setting has a non-blank value or is removed from the master.config completely the SiteScope page will display. The SiteScope Starting page displays by default. |
| _loginHTMLHeader |
HTML that is inserted at the top of the SiteScope login page. If SiteScope users are defined and enabled, this HTML text will be displayed above the "SiteScope Login" title on the login page. For example,<center> HELLO WORLD 12345 </center> will display the text HELLO WORLD 12345 centered above the login title |
Customizing the SiteScope Multi-view Display
The following settings can be used to change the display of the SiteScope Multi-view interface:
|
Key |
Description |
| _overviewRefreshRate |
The interval, in seconds, at which the SiteScope Multi-view page will be automatically refreshed by SiteScope. The default value is:60 |
| _overviewColumns |
The number of columns to be displayed on the Multi-view page. The default value is:1 |
| _overviewOptions |
The HTML/Javascript open.window attributes assigned to the Multi-view window when it is first opened by clicking on the Multi-view button or link. This value can be set using the SiteScope interface in version 7.8.1.2 and later. The default value is:=toolbar=no, width=200, height=400, directories=no, status=no, scrollbars=yes, resizable=1, menubar=no |
| _overviewHideUserLinks |
Hide all links on the read-only version of the Multi-view page. |
| _overviewServerFont |
The HTML font size attribute used to set the relative font size to use for server names displayed in the Multi-view. The default value is:+0 |
| _overviewGroupFont |
The HTML font size attribute used to set the relative font size to use for group names displayed in the Multi-view. The default value is:-1 |
|
overviewHideUserGroups |
A comma separated list of group IDs to be hidden from the non-administrator user in the Multi-view page. The group ID is the *.mg file name without the .mg extension on the end.
|
|
overviewHideAdminGroups |
A comma separated list of group IDs to be hidden from the admin Multi-view page. The group ID is the *.mg file name without the .mg extension on the end.
|
Data Log Settings
These settings control the size, number, and archiving of SiteScope logs.
|
Key |
Description |
| _createDailyAccessLog |
Used for creating daily access logs instead of a single access.log. When this setting is set to true, SiteScope will create daily post logs with filenames in the form of SiteScope \logs \accessYYYY_MM_DD.log. The default value is:true |
| _createDailyErrorLog |
Enable optional daily rolling of the SiteScope Error.log file. This setting must be added in master.config file. The default value is: true |
| _createDailyRunMonitorLog |
Enable optional daily rolling of the SiteScope RunMonitor.log file. This setting must be added in master.config file. The default value is: true |
| _createDailyPostLog |
Used for creating daily post logs instead of a single post.log. When this setting is set to true, SiteScope will create daily post logs with filenames in the form of SiteScope \logs \postYYYY_MM_DD.log. The default value is:true |
| _dailyLogKeepDays |
The number of days of log information to keep before deleting old logs. The default value is:40 |
| _dailyLogTotalLimit |
The maximum total size in bytes of primary log data before old logs are deleted. |
| _dailySiteScopeLogs |
Set to true to create a new, date-coded log file every day. Leave empty to write to SiteScope.log only. The default value is:true |
| _debugLog |
This will create a SiteScope/logs/debug.log. It logs groups loaded at startup. Every 60 seconds it also reports on monitors, threads, and the various SiteScope schedulers listed below: Monitors - shows frequency, last run time, and name of each monitor Threads - shows threads in SiteScope Monitor Scheduler - monitors to execute next Maintenance Scheduler Report Scheduler Action Retry Scheduler Health Scheduler
|
| _logCollectorThreads |
The number of threads that may be used by the data log collectors. Increasing this number to 20 or 25 can be used to improve SiteScope performance in high-load installations. The default value is:10 |
| _logKeepDays |
If daily logs are disabled, the number of days of data to keep in the main data log. The default value is:0 |
| _logFileBufferSize |
Enables and sets the size of a log file buffer for SiteScope application data written to system log files (for example, error.log, access.log, alert.log and so forth). The buffer size setting is in number of characters. Using a value greater than zero will cause SiteScope to buffer data normally written immediately to the system logs until the buffer size is exceeded. This can be used as necessary to enhance SiteScope performance. The default value is: 0 |
| _logFileBufferDuration |
Enables and sets the time duration of a log file buffer for SiteScope application data written to system log files (for example, error.log, access.log, alert.log and so forth). The buffer duration setting is in number of seconds. Using a value greater than zero will cause SiteScope to buffer data normally written immediately to the system logs until the buffer duration time is exceeded. This can be used as necessary to enhance SiteScope performance. The default value is: 0 |
| _logDailyFileBufferDuration |
Enables and sets the time duration of a log file buffer for SiteScope monitor data to be written to the daily log files. The buffer duration setting is in number of seconds. Using a value greater than zero will cause SiteScope to buffer data normally written immediately to the daily monitor log file until the buffer duration time is exceeded. This can be used as necessary to enhance SiteScope performance. The default value is: 0 |
| _logDailyFileMaxBufferSize |
Enables and sets the size of a log file buffer for SiteScope monitor data to be written to the daily log files. The buffer size setting is in number of characters. Using a value greater than zero will cause SiteScope to buffer data normally written immediately to the daily monitor log file until the buffer size is exceeded. This can be used as necessary to enhance SiteScope performance. The default value is: 0 |
| _maxAuxLogSize |
The maximum size in bytes of other (error, access, alert) logs before they are deleted. Logs may grow beyond this size, and are then deleted at SiteScope restart. An empty log is then opened for use. The default value is:1000000 |
| _maxLogSize |
If daily logs are disabled, the maximum size in bytes of the main log. Logs may grow beyond this size, and are then deleted at SiteScope restart. An empty log is then opened for use. The default value is:16000000 |
| _onlyLogEnabledMonitors |
Suppresses logging of disabled monitors to the monitor logs. When set to a non-blank value, the runs for disabled monitors will not be logged in the daily log files. The default value is:foo |
| _postLogFile |
Enables logging of all changes made to SiteScope via the Web browser interface. Set this value to true to have SiteScope keep a log of all the changes made using a browser. The log is recorded to logs/post.log. |
E-mail Alert and Message Settings
These settings affect the sending of E-mail:
|
Key |
Description |
| _autoDaily |
If _autoEmail is set then this setting will send a daily status email message at 7:07am. These settings can both be set using the E-mail Preferences page. |
| _autoEmail |
The E-mail address used for E-mail alerts and messages for the SiteScope administrator. |
| _hideServerInSubject |
Used to suppress the originating server address from E-mail subject field. Set to true to suppress the (your.server.com) from the end of the Subject field in SiteScope E-mail alerts. |
| _mailServer |
The SMTP mail server that SiteScope should use for sending E-mail. This value can be set using the E-mail Preferences page. The default value is:mail.freshtech.com |
| _mailSubjectMax |
Used to truncate the length of strings used in E-mail alert subjects. When the subject text is greater than this length, the text string is truncated to the number of characters specified by this setting. The default value is:160 |
| _mailToFromRemoveBrackets |
Removes the angle brackets from RCPT TO:<captMerc@merc-int.com>, so it looks like this: RCPT TO:captMerc@merc-int.com The default value is:true |
Pager Alert Settings
These settings affect Pager Alerts:
|
Key |
Description |
| _delayBetweenPages |
The number of seconds to wait after hanging up the modem before another pager message is sent. The default value is:5 |
| _pagerAttempts |
The number of times to try sending a pager message. The default value is:4 |
| _pagerAttemptDelay |
The number of seconds to wait between each attempt to send a pager message. The default value is:120 |
| _pagerInitOptions |
Initialization commands passed to the modem used by SiteScope to send Pager alerts. |
| _pagerTimeout |
The maximum total time in seconds to wait for a pager message to be sent. The default value is:45 |
Post Alert Settings
These settings affect the sending of Post Alerts:
|
Key |
Description |
| _postAttempts |
The number of times to try sending a Post Alert, if the first attempt is unsuccessful. The default value is:4 |
| _postAttemptDelay |
The number of seconds to wait between each attempt to send a Post Alert. The default value is:120 |
Settings Controlling URL Monitoring
These settings affect the monitors that check URLs.
|
Key |
Description |
| _sslSessionKeepAlive |
Set to true to keep the SSL Session alive when monitoring HTTPS sites. |
| _sslgetOptions |
When this is set to -ignoreErrors SiteScope will ignore "certificate name mismatch" errors. Set to -ignoreUnknownCA to ignore "certificate authority" errors. The following entries may be put in the Post Data field of an individual monitor: sslgetOptions: -ignoreErrors -ignoreUnknownCA -x User-Agent: Custom-Header: |
| _sslJavaEnabled |
Only used in URL type monitors. SiteScope will attempt to create a Java SSL connection. If this fails then both _sslJavaEnabled and _sslJavaDisabled are not referenced.
|
| _sslJavaDisabled |
see the javasslnote about _sslJavaEnabled above. The default value is:true |
| _urlAllowNoStatus |
Set to true to allow Web pages without a status result. |
| _urlContentMatchMax |
The maximum number of content bytes to save for content match checks. The default value is:50000 |
| _urlHeaderLinesToSave |
The number of header lines to report in content match errors. The default value is:15 |
| _urlMonitorUseApacheHttpClient |
Enables SSL support in the URL Monitor when using Proxy and SSL on UNIX. The HTTPClient can be used in the same manner as sslget is used on Windows platforms. It supports only GET requests, and only when using HTTPS. |
| _urlOtherHeader |
Additional header to pass in HTTP requests. Set this to Pragma: No-Cache is part of speeding up image download, if Retrieve Images is checked on a URL monitor, and the download is very slow. See the urlloadthdsnote for _urlLoadThreads also. The default value is:Pragma: No-Cache |
| _urlLoadThreads |
The higher you set this the more threads will be allowed to download a URL page, images, and frames. 4 is a good number. 1 is the default internal number. Set this number higher to help speed up download of images, if Retrieve Images is checked. This is mainly used to simulate browser performance. You may include this setting in a monitor group file header or individual monitor frame to limit the scope to a group or monitor. The default value is:1 |
| _URLUserAgent |
The user agent identifier sent in HTTP requests. The default value is:Mozilla/4.0 (compatible; MSIE 4.01; Windows NT) |
| _urlRedirectMax |
The maximum number of HTTP redirects to follow before returning an error. Set to -1 to disallow redirects. This will probably require changing the error and warning thresholds of the monitor to make a 301 Error OK. The default value is:10 |
| _urlUnixSSL |
Set this to anything for HTTPS URL monitors that use Cookies, and are using SSL through Java, rather than sslget through Windows. Cookies will be formatted on one line using this; while sslget requires one Cookie per line. |
| _urlLocation |
This setting defines a monitoring location for the Global URL monitor. The default value is: this server |
| _URLSequenceMonitorSteps |
The maximum number of steps to allow in a URL Sequence monitor. You can set this larger than 20 to allow more steps, but if you set it less than 20 the code will reset it to 20. You cannot create more steps than this number using the interface. The default value is:20 |
| _urlKeepAlive |
If this is set to -1, and you are getting unknown error (-1) on URL monitors, change it to 0 and run the monitor. The default value is:0 |
| _getExternalFiles |
Add this setting in the master.config or an *.mg file to include loading of Javascript files, applets, and cascading style sheets with Retrieve Images checked on a URL type monitor. This will get files, but does not emulate user experience. Delete the setting or set the value to blank to disable. The default value is:true |
| _urlHTMLInJavaScript |
Include everything between the following HTML tags in parsing Web pages: <script", "</script> <noscript", "</noscript> By default these tags are ignored. Delete the setting or set the value to blank to disable. The default value is:true |
| _ignoreScripts |
Ignore everything between the following HTML tags in parsing Web pages. <script", "</script> Delete the setting or set the value to blank to disable. The default value is:true
|
| _urlCertDays |
May be used in master.config, at the top of an *.mg file or in a monitor frame in an *.mg file for the desired monitor. If _urlCertDays=true is set and the monitor is using Java ssl, then an attribute called "Certificate Expiration Days Remaining."in the good,error,warning drop downs at the bottom of URL monitor details page advanced features takes effect. This can be used to set a threshold with respect to the number of days till the cert expires. Try it by going to https://someSecureSite.com and setting the error for "Certificate Expiration Days Remaining." != 1. It turns the monitor red. Without _urlCertDays=true the monitor stays green. Do not check "NT Challenge Response" or Microsoft ssl libraries will be used, which does not provide processing for _urlCertDays. This may require manually adding certificates for Java. The default value is:true |
| _URLMonitorProxyExceptions |
Can be used in the master.config or in a *.mg file. Will not use the proxy defined for the monitor for URLs with these hosts. Use the <host> in the comma separated list. Assumes URL formats of <protocol>://<host>[:<port>]/< document> The default value is:<host>,support. mercuryinteractive. com, www. xxanysite.com, bobzzz.com |
| _urlDetailLogEnabled |
Can be used in the master.config or in a *.mg file. It logs into the logs/url.log a multi-line entry for each URL that is retrieved by SiteScope. The name of the url.log may be changed with the _urlLogName=urlSiteScope.log The FORMAT of each log entry is: locationPrefix+urlString+ "\t"+status+ "\t"+totalDuration+ "\t" +totalBytes+ "\t"+lastModified+ "\t"+currentDate+ "\t"+dnsTime+ "\t"+connectTime+ "\t" +responseTime+ "\t"+downloadTime+ "\t"+Monitor(pName)+ "\t"+Monitor(pGroupID) +"\t"+Monitor(pID)) May add an entry for each URL of a Link, URL Sequence, URL Content, or URL Monitor. The default value is:true |
| _concatURLRedirects |
append all of the redirect pages, like they appear at the bottom of the URL Tools page. This is useful for pattern matching in the headers and redirect HTML pages. This includes the final page. The default value is:true |
Report Settings
These settings affect SiteScope Reports.
|
Key |
Description |
| _alertReportDefaultPeriod |
Set to the number of seconds that Alert History reports are run over. |
| _fullMonitorName |
Works only in master.config, applies to all monitors. Uses long 'path like' file name in reports and daily logs. Resulting full file name: toplevelGroupName: subGroupNames: monitorName The default value is:InReportsAndDailyLogFile |
| _maximumReports |
The number of old reports to keep before old reports are deleted. The default value is:10 |
| _userDisableQuickReports |
Set to true to hide the Quick report link from the read-only report page. |
| _reportAutoScale |
Set to true to scale the report graph to the maximum value in the graph. |
| _chartHeight |
300 is default (make sure to set > 50), so look at graphs and use this as a starting point to change this value if you want a custom height on your report graphs. Add this to master.config or a report frame in history.config. Generally, l et SiteScope set this for you. The default value is:300 |
| _chartWidth |
600 is default (make sure to set > 50), so look at graphs and use this as a starting point to change this value if you want a custom width on your report graphs. Add this to master.config or a report frame in history.config . Generally, let SiteScope set this for you. The default value is:600 |
| _reportDelimiter |
The character to use to separate the text version of reports. The default value is:, (comma) |
| _reportMaxBuckets |
The maximum number of bars in a graph. The default value is:100 |
| _reportFooterHTML |
Custom HTML mark-up added to the footer area of report pages. Values must be valid HTML and text. The default value is blank |
| _reportFormat |
One or more entries used to define named, alternate report formating styles. Two alternate report formats are provided by default. Each reportFormat must include a _id=name and _title=title_text that are unique. Other setting-value pairs must match the other report customization settings settings and values as described in this table. Setting-value pairs are separated by spaces with other white space replaced with the underscore (_)character. For example, the default value for the reportFormat with _id=noBorders is:_title=color_background, _no_table_borders, _reportTableHTML= CELLSPACING=1_BORDER=0 |
| _reportGraphBackgroundColor |
The back ground color used as a border to outline report graphs. Values must be valid HTML color definitions. The default value is:#DDDDDD |
| _reportGraphDisabledColor |
The bar graph color used to highlight intervals during which a monitor was disabled in the report graphs. Values must be valid HTML color definitions. The default value is:#44AACC |
| _reportGraphErrorColor |
The bar graph color used to highlight error results in the report graphs. Values must be valid HTML color definitions. The default value is:#EE7777 |
| _reportGraphGoodColor |
The bar graph color used to highlight good results in the report graphs. Values must be valid HTML color definitions. The default value is:#88CC99 |
| _reportGraphMaxColor |
The bar graph color used to highlight the maximum reading during report intervals containing more than one monitor result. Values must be valid HTML color definitions. The default value is:#CCCCCC |
| _reportGraphNoDataColor |
The bar graph color used to highlight intervals during which a monitor reported no data in the report graphs. Values must be valid HTML color definitions. The default value is:#FFFFFF |
| _reportGraphWarningColor |
The bar graph color used to highlight warning results in the report graphs. Values must be valid HTML color definitions. The default value is:#EEEE77 |
| _reportHideLogo |
Controls the display of the legacy SIteScope "fish" logo on the report pages. Set this to false to enable the logo. The default value is:TRUE |
| _reportHTML |
Custom HTML mark-up added to the top of report pages. Values must be valid HTML and text. The default value is blank |
| _reportIndexHTML |
Custom HTML mark-up added to the top of the Management Report Index page. Values must be valid HTML and text. The default value is blank |
| _reportScale= |
A set of scale factors used to calculate the vertical axis of report graphs. The default value is:1,2,5,10, 20, 50, 100, 200, 500, 1000, 2000, 5000, 10000, 20000, 50000, 100000
|
| _reportTableDataHTML |
The HTML tr (table row) attributes used to control back ground color for the table body rows for all report tables. Values must be valid HTML attributes. The default value is:BGCOLOR="#DDDDDD" |
| _reportTableDisabledColor |
The table cell background color used to highlight intervals during which a monitor was disabled in the report tables. Values must be valid HTML color definitions. The default value is:#44AACC |
| _reportTableErrorColor |
The table cell background color used to highlight error results in the report tables. Values must be valid HTML color definitions. The default value is:#EE7777 |
| _reportTableGoodColor |
The table cell background color used to highlight good results in the report tables. Values must be valid HTML color definitions. The default value is:#88CC99 |
| _reportTableHeaderHTML |
The HTML tr (table row) attributes used to control back ground color for the header rows for all report tables. Values must be valid HTML attributes. The default value is:BGCOLOR="#88AA99" |
| _reportTableHTML |
The HTML table tag attributes used to control back ground color, cell padding and cell spacing for all report tables. Values must be valid HTML attributes. The default value is:BORDER=1 CELLSPACING=0 |
| _reportTableNoDataColor |
The table cell background color used to indicate a no data result in the report tables. Values must be valid HTML color definitions. The default value is:#FFFFFF (white) |
| _reportTableWarningColor |
The table cell background color used to highlight warnings in the report tables. Values must be valid HTML color definitions. The default value is:#EEEE77 |
| _maxReportErrors |
The maximum number of entries in the error table section of a report. The default value is:100 |
| _hideReportTables |
Set to true to hide the Table section in all reports. |
| _hideReportGraphs |
Set to true to hide the Graphs section in all reports. |
| _hideReportErrors |
Set to true to hide the Errors section in all reports. |
| _noScientificNotation |
Changes the format from 3.14E0 to 3.14159 in reporting numbers in CSL, XML and HTML report files. When this is in use, numbers that contain commas are treated as numbers, rather than text for reporting purposes. See KB article on report number format. The default value is:#.##### |
| _maxStatusLength |
Length of the status text of each monitor shown in reports that show errors/warnings/goods tables (nothing to do with graphs). By default you will get 256 characters. The default value is:256 |
| _reportDefaultSamples |
<defaults to 48, if not found in master.config> This takes effect if you are running a Quick report or if a window= tag is not found in the history.config file for this report. Increasing this number will increase the length of time covered by the report. If running a Quick report or window= tag not found then: window = _reportDefaultSamples * minimumFrequency where minimumFrequency is the smallest frequency value of all the monitors in the report in seconds. When using _reportDefaultSamples the endTime for the window is set to the current time in seconds. Then the startTime for the window is set to endTime - timeWindow in seconds. This is different from the sampling buckets. Sampling buckets are used to determine how the monitor runs will be grouped together to determine one data point on the graph. The default value is:48 |
SNMP Settings
These settings are related to SiteScope interaction and behavior related to SNMP.
|
Key |
Description |
| _snmpMonitorMaximum |
The maximum number of SNMP monitors that can run at any given time. The default value is:10 |
| _snmpMaxCounter |
The max rollover value for Delta calculation on an SNMP monitor that you choose to compare readings. Set this to the max value that the monitor will have. You may add this to the monitor in the *.mg file for limited scope. The default value is:1000000 |
| _snmpTrapListener |
The port that SiteScope should use to listen for SNMP Traps. An SNMP Trap monitor must be configured to start the SNMP Trap listener for this port in SiteScope. The default value is:162 |
| _snmpTrapListenerIP |
The IP address of the Port that the listener will run on. Default is the IP of the machine SiteScope is running on. This allows users to select an IP address if the SiteScope server has multiple IP boards. |
| _SNMPTrapMonitorDetailsMax |
Limits the amount of text that goes into the <matchDetails> property for alert templates. Use when the Run Alerts field is set to Once, after all checked on SNMP Trap Monitor setup page. The <matchDetails> property must be added to the alert templates used by the applicable monitors. Restart SiteScope after modifying template files, if not using the _ignoreTemplateCache=true setting. See the chapter on alerttemp00Custom Alert Templates for more information on modifying alert templates. The default value is:1000 |
| _snmpTrapNoSystem |
By default the string 1.3.6.1.2.1 is pre-pended to the beginning of SNMP Trap OID VARIABLES. Use this flag to leave the OID unchanged. This applies to SNMP Trap OID variables that are bound to the primary SNMP Trap OID that SiteScope sends. SiteScope only reports SNMP variables of type STRING. SiteScope does not report the individual variable OIDs, it only reports the individual variable messages. The default value is:true |
| _snmpTrapNoSystemNotify |
This applies to _alertCondition tags that define SNMP Trap alerts. May be used in the master.config or *.mg files. By default the string 1.3.6.1.2.1 is pre-pended to the beginning of an SNMP Trap OID. Use this flag to leave the OID unchanged. Add this tag to the end of the line beginning with _alertCondition (add one blank space and then this tag) or as a new entry in the master.config for global effect. The default value is:true |
Connectivity with Remote Servers
The following settings are used for defining and controlling connections with remote servers
|
Key |
Description |
| _connectDelay |
The number of milliseconds to delay, defaulting to 3000 if the number is 0 or 480000. Add as a new entry in the ..\SiteScope\groups\master.config file or append to a _remoteMachine or _remoteNTMachine entry using SSH. The default value is:3000 |
| _disableCache |
Used to force telnet, ssh, rlogin to login each time a command (or monitor) runs. This disables any cached connections to remote UNIX machines. This can be added to master.config or _remoteMachine as a parameter. The default value is:true |
| _remoteMachine |
UNIX remote machine definition. Internal use. Only edit this using specific instructions in Technical Notes for custom features. |
| _remoteShell |
If it is not possible to permanently change a UNIX account shell or prompt on the remote, you can add the _remoteShell to change the shell for SiteScope. These changes will only apply to the connections from SiteScope. The default value is:exec sh |
| _remoteNTMachine |
Windows remote machine definition. Internal use. Only edit this per tech note instructions for custom features. |
| _remoteShellInit |
This can be used to change environmental variables from the userlevel if it is not possible to change them permanently. For example, _remoteShellInit=echo shell=$SHELL;PS1=;echo prompt=$PS1;stty -echo |
| _setUnixFilePermissions |
Overrides how SiteScope handles file permissions on UNIX. Setting the value to false will stop SiteScope from changing any of its file permissions. Setting this value may have unknown effects if the system defaults are not set properly. |
| _unixFileMask |
setting works exactly the same as umask(1) on UNIX, with one exception: it is not permitted to change the umask of the user bits. See man pages for umask for a complete description. |
| _windowsShellCommand |
Used as the command line when starting Windows SSH sessions using the SSH client Specifically enables SiteScope to connect to FSecure servers. The value is normally added via the UI and set in the remote machine definition. |
Monitor Settings
The following are settings that may effect specific monitor behavior.
|
Key |
Description |
| _dialupOptions |
Set to -silent to make the modem do silent dialing. Set to -debug to enable dialup debugging. |
| _dnsNameTags |
Enables the DNS Monitor to support environments with multiple-language operating systems. Used to list equivalents for the Name label from the DNS server nslookup operation in multiple-language operating system environments. May include a comma separated list of multi-language label equivalents. For example, _dnsNameTags=Name, Nom, Nombre |
| _dnsServerTags |
Enables the DNS Monitor to support environments with multiple-language operating systems. Used to list equivalents for the Server label from the DNS server nslookup operation in multiple-language operating system environments. May include a comma separated list of multi-language label equivalents. For example, _dnsServerTags=Server, Serveur, Servidor |
| _eventLogMessagesToSave |
Number of NT Event Log descriptions to save when saving diagnostic text for alerts. The default value is: 3 |
| _browsableExeTimeout |
Browsable counter monitor timeout value, in milliseconds. As of May 2003, this only applies to SAP Monitor, Sybase and DB2 Monitor. The timeout is used on retrieving counter info and for running the monitor. Set in master.config, group file or an individual monitor frame. The default value is:45000 |
| _ftpContentMatchMax |
A performance tuning setting for FTP monitors to limit the size of the byte buffer used for content matching. The default value is:50000 bytes. |
| _keepTryingForGoodStatus |
Sets the number of attempts to try for a good status. Uses a different URL api. Also escapes blanks in forwarding links. Manually add this setting to monitor group file or to a individual monitor frame in a group file. The default value is: 7 |
| _logMonitorDetailsMax |
For Log File Monitor with /(.*)/s as the regular expression. This will match the entire contents of the new entries to the file to be sent in the alert text. If the matched text is longer than this number of characters the text will be truncated. Use the <diagnosticText> or <matchDetails> properties in an alert template in SiteScope\templates.mail directory, and use this template in the alert. See the chapter on alerttemp00Custom Alert Templates for more information on modifying alert templates. The default value is:1000 |
| _linkSummaryMax |
Number of links to show on Link Check Monitor Summary Page. The default value is:500 |
| _maxAmountToRead |
The number of bytes to read from the Web server log file for the Web Server Monitor. The default value is:50000 |
| _NTCounterMonitorMaxCounters |
The maximum number of counters read from a NT PerfMon document. The default value is:8 |
| _NTEventLogMonitorDetailsMax |
Limits the amount of text that goes into the <matchDetails> property for alert templates. Use when the Run Alerts field is set to Once, after all checked on SNMP Trap Monitor setup page. The <matchDetails> property must be added to the alert templates used by the applicable monitors. Restart SiteScope after modifying template files, if not using the _ignoreTemplateCache=true setting. See the chapter on alerttemp00Custom Alert Templates for more information on modifying alert templates. The default value is:1000 |
| _comPlusMonitorGetBrowseTreeTimeout |
A timeout value for the COM Plus Monitor browse counter tree operation. Used to timeout the browse counter operation only when setting up the monitor and selecting counters to monitor. The default is 120 seconds. |
| _NTCounterSummaryMax |
Sets the number of entries displayed from a request made by a NT Performance Counter Monitor. Increasing this value will display more entries from the response received by a NT Performance Counter monitor in the monitor status field. If you see an ellipsis (...) at the end of the status it means there were more entries than were displayed. The default value is:3
|
| _scriptMonitorTimeout |
The Script Monitor timeout setting can be added manually to master.config or *.mg files, and cannot be set through the browser User Interface. This timeout option is supported only on SiteScope for Windows and only for the local machine (that is, this server or localhost). The setting _timeout=30000 can also be added manually to an individual Script Monitor instance frame in a monitor group file. Any monitor property or setting of _timeout will override the _scriptMonitorTimeout setting if both values exist in the monitor frame. The timeout is set in milliseconds for both settings. Including Setting the _scriptMonitorTimeout setting for a monitor for which this setting is not supported will not have any effect on the monitor run. The default value is:60000. |
| _localScriptLocation |
Allows a SiteScope API client to create a Script Monitor specifying a different location from which to find and execute script files. The default will only run scripts from the SiteScope\scripts folder. Add this to the SiteScope\groups\*.mg file frame for a Script Monitor. For example, _localScriptLocation= C:\SiteScope\ myExecutableScripts |
| _usePreviousRecordCount |
Used by NT Event Log Monitor to continue using an existing record count after a new connection with the remote is established. The default value is:true |
| _scriptMonitorReplacementChars |
Used to pass normal script replacement characters ($ or %) through SiteScope to a script on a remote machine. Specifically added for cases where customers are running a USE COMMAND script against a remote UNIX machine and want to pass parameters. The default value is: $ % Add or change this setting in the master.config, monitor group file headers, or individual monitor frames. Replacement tokens are separated by a blank space. The default replacement characters are $ and %. For example, you may use a command like the following: /usr/bin/top -n 1 | grep '$1' | awk '{print $9}' | awk -F "." '{print $1}' Normally, if you passed a parameter to this script then SiteScope would substitute that parameter's value wherever it sees a $1. For this example, assume you use sshd as your parameter. SiteScope would substitute sshd wherever there is a $1 so the command that gets run would be: /usr/bin/top -n 1 | grep 'sshd' | awk '{print $9}' | awk -F "." '{print sshd}' This is not the desired result: the last print $1 should actually print the first value of the output of this command not sshd. To correct this you can set _scriptMonitorReplacementChars=@ , for example, and then change your script to use this character as follows: /usr/bin/top -n 1 | grep '@1' | awk '{print $9}' | awk -F "." '{print $1}' For this example, SiteScope passes the sshd parameter to replace the @1 and not the $1 which produces the desired command of: /usr/bin/top -n 1 | grep 'sshd' | awk '{print $9}' | awk -F "." '{print $1}' Another example in the Script Monitor command, using _scriptMonitorReplacementChars as described above: ps -ef | grep 'AThirdReplacementToken1 Your_SiSc_RPL_TOKEN4 ^2' | wc -l | awk '{print $1-1}' Using the Script monitor parameters: hello secondParam isssThirdfourthParam testtttFifth match field:/(1)/ when the monitor runs this is the command sent, leaving the $1 alone: ps -ef | grep 'hellofourthParam secondParam' | wc -l | awk '{print $1-1}' The result returned is 1 if the command finds a match on the remote, 0 if not. Generally, this example will be 0.
|
| _sunOneMonitorGetBrowseTreeTimeout |
A timeout value for the SunOne Monitor browse counter tree operation. Used to timeout the browse counter operation only when setting up the monitor and selecting counters to monitor. The default is 120 seconds. |
Other Settings
The following are other settings that control miscelleaneous SiteScope and monitor behavior.
|
Key |
Description |
| _localPortRetryCount |
Number of times to try and open a port in the 811-1024 range for rlogin and rsh remote access methods. The default value is:25 |
| _lockWebserverAddress |
On SiteScope for Linux, locks the Web Server Address entry on the General Preferences page from reverting to localhost after it is changed to IP or computer name. The default value is:true |
| _initialMonitorDelay |
Time, in seconds, over which to randomly schedule monitor updates after a SiteScope restart. The default value is:60 |
| _monitorDelayBetweenRefresh |
Delay time in milliseconds (1000 msec = 1 second) to run a monitor after it has already been run since startup. This takes precedence over the _initialMonitorDelay setting, If there is a non-zero value for last= in the groups\*.dyn file for this monitor. This will cause monitors to spread out more, as more monitors are started. The default value is:1000 |
| _oracleJDBCConnectionCaching |
For Oracle Database monitors, allows SiteScope to cache connections when this is needed to improve performance. Set the value to true to enable caching. |
| _exclusiveMonitorTimeout |
For exclusive monitors, the scheduler is stopped, and wait for other monitors to finish before running. Because this code is run in the same thread as the scheduler, the scheduler will be waiting for the following loop to complete. As of April 2003 only the NTDialup Monitor uses this. The default value is:300 |
| _tempDirMaxSize |
Used to govern the maximum size of the SiteScope\cache\tempbysize and SiteScope\cache\tempbyage directories. The tempbysize directory is used if you have the Astra Load Test monitor. The tempbyage keeps timestamped snapshots of old master.config files. The default value is: 10000 |
| _registerCC |
No longer used. In old versions of SiteScope, this was used to send a copy of registration E-mails to the address specified. This will be removed from the default.config in future releases. |
| _noAlertScriptParameters |
Turn off the six parameters or arguments that SiteScope passes to scripts or script Alerts. This can also be set at the machine level by using this on _remoteMachine= entries in the master.config file. The default value is:true |
| _startupScript |
Run this script whenever SiteScope starts running. Enter the fully qualified path accessible to the server on which SiteScope is installed. On SiteScope for UNIX the script /SiteScope/start starts SiteScope. The _startupScript setting will run the script specified after SiteScope starts, regardless of the platform or procedure used to start SiteScope. |
| _timeZoneOffset |
For SiteScope on UNIX, manually sets the time zone offset in hours. The default value is:-999 |
| _tracerouteCommand |
For SiteScope on UNIX, specify the path to the traceroute utility. |
| _userRedirectFile |
Specifies a file name into which the contents of user.htm will be copied. |
| _adminRedirectFile |
Specifies a file name into which the contents of admin.htm will be copied. |
| _alertLogReadChunkSize |
Set the number of bytes that are read from the alert.log file for each read. This is used for when running reports on alerts that were generated. The default value is: |
| _verifySleepDuration |
The number of milliseconds to wait before re-running a monitor using the Verify Errors option. The default value is:5000 |
| _perfexOptions |
Specifies additional command line options to pass to perfex, for example, -timeout 60000. This value gets tacked on to the end of every perfex command. It can be used to force fixed values, since the last values passed to perfex win. It can be anything legal command line option to perfex. For example, -d timeout 59000 would turn on debugging and fix the timeout to 59 sec, even if another -timeout was in the command line. To turn off perfex caching, the option to set is -disconnect. |
| _restartDelay |
Sets the number of hours between SiteScope auto restarts. |
| _dependsOnRecursive |
Specifies that subgroups will become disabled, if the parent group becomes disabled because of a dependency. By default only the immediate group that the dependency impacts is disabled. The default value is:true |
| _backupDyns |
If set to anything, this will stop creating SiteScope /groups /*.dyn.bak files. The *.dyn files are the dynamic monitor group files used by SiteScope during runtime execution. Using this flag will decrease the number of file system file handles created. This may help with Java file handles exceptions. The default value is:1 |
| _backupGroups |
Enable SiteScope to backup the groups directory every 24 hours. This is useful for restoring files group files and master.config in the case that the working files become corrupted. This setting must be added inmaster.config file. The default value is: true |
| _configJdbcShowDDCLink |
Enables the display of the Data Driven Configuration link. The default value is:true
|
| _fileCheckFrequency |
The interval, in seconds, at which the external configuration file specified for Database Driven Configuration will be automatically checked by SiteScope. The default value is:120 |
| _ignoreMissingTemplateProperties |
When set in master.config, group file header frame or individual monitor frame, this will cause SiteScope to silently ignore missing properties that are referenced in template files. Specifically added for SNMP alert templates. The default value is:true |
| _noCheckDefaultThresholds |
In version 7.8.1.1 this is the default SiteScope behavior for checking monitor status. When set to true (or when the setting is not found in master.config, monitor group files, or in monitor frames), SiteScope will only check the result of the monitor against the error, warning and good thresholds displayed on the user interface of the Add/Edit Monitor Page for each monitor. If no user-selected error, warning, or good threshold condition resolves to true, the monitor status will be reported as "good". The effect is that any inconsistencies or conflicts in error, warning, and good thresholds logic or limits are ignored. When the value of _noCheckDefaultThresholds is set to false, SiteScope will check monitor results against any user-selected thresholds and also against the default (hard-coded) SiteScope thresholds for that monitor type. For both setting options, the first threshold that resolves true stops all further threshold checking. The default value is:true |
| _acknowledgeManuallyClear |
Specifies behavior relative to monitor status acknowledgements. When set to 1, acknowledgements will not be cleared when the monitor status changes (the default behavior); the user must clear acknowledgements manually. This is to be added as an option in SiteScope interface for versions after 7.8. The default value is:1 |
| _redirectStandardError |
Used to redirect the standard errorto a date-coded log file. The file is written to the SiteScope/logs/ directory and will have the format of stderr_YYYY_DD_MM.log. A timestamp will be written every 10 seconds so that the data in the file can be correlated. This enables recording exceptions that may not be otherwise caught by the application program. This setting is effective in SiteScope version 7.8.1.2 and later. The default value is:10
|
| _redirectStandardOut |
Used to redirect the standard errorto a date-coded log file. The file is written to the SiteScope/logs/ directory and will have the format of stdout_YYYY_DD_MM.log. This setting is effective in SiteScope version 7.8.1.2 and later. The default value is:true.
|
| _webserverAddress |
the Web Server Address entry on the General Preferences page. May be changed to IP or computer name. Used in E-mail alerts. The default value is:localhost |
SSL Settings
If your Topaz is using ssl encryption to communicate with SiteScope, these settings are used to configure SiteScope as a client to send information to Topaz.
|
Key |
Description |
| _sslTrustedCertKeyStoreFile |
Specifies the keystore file (if any) containing valid certs to be accepted in addition to canonical trusted certs. Use the fully qualified path with the filename. |
| _sslTrustedCertKeyStorePassword |
Contains the password for the corresponding keystore file |
| _sslAcceptAllUntrustedCerts |
Used to accept certs that may not have a trust chain. When set to true, any cert will be accepted. Otherwise only certs specified in the keystore file or that have a trust chain that leads to a registered CA will be accepted. |
Topaz Settings
If your Topaz is using ssl encryption to communicate with SiteScope, these settings are used to configure SiteScope as a client to send information to Topaz.
|
Key |
Description |
| _topazConfigurationHost |
When the Topaz Monitoring Configuration Console (TMC) imports and attachs to a SiteScope installation, this setting is added to the SiteScope master.config settings. When SiteScope is under control of the Topaz Monitoring Configuration Console, only certain editing actions are allowed through the SiteScope native interface, regardless of the user or account privileges. Even the SiteScope administrator user will not be able to perform certain actions while SiteScope is under TMC control. Detaching the SiteScope installation from TMC will cause the setting to be removed from master.config and SiteScope will again respond normally to local user profiles as defined in the users.config. For internal use only. Effective in SiteScope version 7.8 and later. |
| _topazSyncFrequency |
Sets how often, in seconds, to synchronize SiteScope's configuration with Topaz. By default, SiteScope synchronizes its configuration data with Topaz every 5 minutes. This means the group names, structure, and settings and the monitor hierarchy contained within the monitor group files is synchronized. The default is 300 minutes.
|
| _topazLogMonitorCache |
Sets the maximum number of monitors to cache before reporting to Topaz (the default is 30 monitors). This setting and the _topazLogTimeCache setting control how often SiteScope synchronizes the SiteScope monitor results to Topaz. Increase these numbers if you do not want the buffers to be reported as often. Decrease these numbers if you do not want the size of the buffers that are reported to be too large.
|
| _topazLogTimeCache |
Sets the maximum number of seconds before reporting to Topaz The default value is:60 |
Performance Tuning and Process Pool
These are settings that control the use of the Process Pool implemented .
|
Key |
Description |
| _doNotKillProcesses |
Used to provide a list of processes that SiteScope should not kill during restart. Used together with the _killProcesses and_processDestroyTimeout settings. |
| _killProcesses |
Used to have SiteScope try and kill off processes that may have been left as zombies when SiteScope restarts itself. By default the processes killed areplink.exe, ping.exe, SendModem.exe,srvrmgr.exe and perfex.exe. The list of processes can be overridden by the_doNotKillProcesses setting. Used together with the _processDestroyTimeout and_doNotKillProcesses settings.
|
| _processDestroyTimeout |
Controls how long SiteScope will wait for Java to destroy processes on its own. The value of this setting is given in milliseconds. Used together with the _killProcesses and_doNotKillProcesses settings. |
| _maxMonitorProcesses |
Sets the maximum number of operating system processes that are run simultaneously to support process-based monitor types (for example, Service, CPU, Disk, and Performance Counter monitors). This governs the number of external processes that SiteScope is allowed to spawn. In version 7.9.0.0 this includes plink, netstat, cmd for example. Perfex used to be fall in this category but it's now handled through the processPool. The default of 5 external processes is not enough in some environments. Your hardware may support more external processes so this can be set at 50 or more in some cases. This improve preformance where monitors may otherwise be waiting for an available external process.The default value is:5
|
| _maxMonitorsRunning |
Sets the maximum number of monitor instances that are can be run simultaneously. The default value is:100
|
| _memoryPageSize |
Used for monitoring UNIX remotes. If there is no setting for the that's used in several commands. Normally the pageSize setting is included in the remote UNIX adapter config file. If there is no setting then SiteScope will use the value of the _memoryPageSize. The default value is: 8192 |
| _monitorProcessCheckDelay |
This item specifies the amount of time, in seconds, between checks for an active SiteScope monitoring process. This must be in this range (30 <= value <= 300) of seconds. If outside range, SiteScope sets to one of the limits, based on this value. 400 changes to 300, 2 changes to 30. |
| _perfexTimeout |
Defines a timeout value, in msecs, for processes that use perfex so that it releases processes in a timely fashion and does not hold up process threads. An example value for performance tuning is 120. |
| _processPool |
Set to true for using the process pool, false to disable it. See the other tags that start with _processPool for more information on its use. The default value is:true |
| _processPoolMaxPerPool |
The max number of processes to open per pool. The default of 20 , should be sufficient for about 200 monitors per minute. For every 100 more monitors per minute, add 10 (for example, to use 500 per minute, set the value to 50 ). The default value is:20 |
| _processPoolKillTimeout |
The time to wait (in milliseconds), after a timeout in a task occurred, before killing the process. This is to avoid killing the processes on every timeout. The default value is:120000 |
| _processPoolMaxKillTimeout |
The maximum time to wait (in milliseconds) before killing a process. This is to kill processes that may have become zombied. |
| _processPoolTimeout |
The time in seconds for a process exit (for cleanup reasons). The default is SS restart, so there is no processes restarts by default (this entry does not exist in default.config). If you are running a process that is controlled by the process Pool that needs to restart more frequently than 24 hours, due to a memory leak or handle leak or something, then set this value. Currently only perfex is in the process pool and has no known problems. Also, the ping monitor now uses perfex. The ping.exe is not used in SiteScope 8.0 |
| _threadPoolMaxIdle |
Governs the max number of idle threads allowed in the thread pool before the thread pool size is cleaned (reduced). If more than one third of the running threads in the pool are idle, and the number of _threadPoolMaxIdle has been reached, half of the idle threads will be cleaned. The default value is: 100 |
| _useThreadPool |
Enables the use of the thead. There are two 2 main thread pools in SiteScope: one for the monitor runs and one for handling HTTP Requests. The default value is: yes Note: This is internal to the implementation of SiteScope and may be changed in future releases. |
SiteScope Health Monitoring
These are settings that control SiteScope Health monitoring.
|
Key |
Description |
| _healthScheduleMinutes |
Sets how often the health page checks are automatically run. The default is every 3 minutes. It can be set to 1440 minutes so it will run once per day. It cannot be set to 0; the code will override and set it to 3 minutes. The default value for this setting is:3. Health monitoring can be disabled by using the Health page interface. Alternatively, SiteScope health monitoring may be disabled by removing all content from the groups/health.config file. To disable only group file checking remove the frames with _class=Mg, _class=Master, and _class=History in the groups/health.config. |
| _healthScheduleMinutesMg |
Sets how often the monitor group files are checked by Health monitoring. This only applies to monitor groups (*.mg) files, not the history.config or master.config files. It is set large so that Mg files will check at startup and only when the user clicks refresh on Health Mg files check. If this is removed then _healthScheduleMinutes is used. The default value is:5760.
|
| _checkForUniqueMonitorNamesInHealth |
This will check monitor names similar to the way UNIX and Microsoft operating systems check file names. Each monitor in a group must have a unique name. Does not check sub-group names currently. The default value is:true |
| _shutdownOnSkips |
Allows monitors that are skipping to be disabled automatically with an e-mail sent to the administrator instead of restarting SiteScope. This function is disabled by default but is activated by removing the _shutdownOnSkips=true setting in the master.config. The default value is: true |
Calculated Settings
The following settings are written by SiteScope when it is started or during operation. They should not be manually created or edited.
|
Key |
Description |
| _httpActivePort |
The port currently being used by the SiteScope internal Web server. The default value is:8888 |
| _adminURL |
The URL to access to SiteScope administrator pages. The default value is:http:// <severaddress>:8888 /SiteScope |
| _id |
(internal use) The default value is:SiteScope |
| _nextAdditionalScheduleID |
The next ID to use when adding a monitor run schedule. Calculated and stored in master.config. |
| _nextConditionID |
The next ID to use when adding an alert to a monitor, monitor group, or multiple monitors and groups. It may appear within monitor group files in a monitor frame, in the header frame of a monitor group file, or in master.config depending on the scope of the alert definition. |
| _nextNTRemoteID |
The next ID to use when adding a Remote NT connection profile. Calculated and stored in master.config. |
| _nextRemoteID |
The next ID to use when adding a Remote UNIX connection profile. Calculated and stored in master.config. |
| _nextReportID |
The next ID to use when adding a report to history.config. |
| _userURL |
The URL to access the read-only version of the SiteScope pages. The default value is: http:// <severaddress>:8888/ SiteScope/ userhtml/ SiteScope.html |
| _readmeDate |
Timestamp of the readme file. The default value is:902795055000 |
| _version |
This is used to record the version number of the SiteScope executable in the master.config file. It is also used by SiteScope Fail-over. The value is hard coded and should not be changed. |
| _mirrorPageLink |
High Availability value for mirroring. Used only on the SiteScope Fail-over server. Internal use. |
| _haInstalled |
SiteScope Fail-over (formerly High Availability). Internal use. |
First-time Setup Settings
These settings are written by SiteScope when the First Time Setup page is used. They are only used for debugging and do not affect the operation of SiteScope.
|
Key |
Description |
| _webServers |
The Web servers installed on the SiteScope server. |
| _browser |
The first browser used to connect to SiteScope. |
Copyright 2004 Mercury Interactive
Corporation.
All rights reserved.
| | |