Академический Документы
Профессиональный Документы
Культура Документы
Flexense Ltd.
SysPulsar
Server Status Monitor
User Manual
Version 1.6
Feb 2013
Flexense Ltd.
Product Overview
SysPulsar is a server status monitoring solution allowing one to monitor CPU usage, memory usage, disk space usage, disk activities, network activities, etc. The product provides history statistics and multiple types of charts showing the activity timeline, which users were the most active, which disks and directories were the most changed, etc.
SysPulsar Server is especially designed to run on production servers using a very small amount of the system memory (6MB-8MB depending on the number and type of configured system monitors) and CPU resources in order to minimize the performance impact on running production applications.
SysPulsar Server runs as a service in the background and provides a web-based management interface allowing one to control, configure and manage the product using a regular web browser locally or through the network. The user is provided with an automated configuration wizard allowing one to start monitoring a server in a single mouse click. In addition, advanced users are provided with the ability to configure multiple types of system monitors, save PDF, HTML, XML, text, Excel CSV reports, enable error logs and/or send E-Mail notifications when a system monitor drops below or rises above a user-specified limit.
Flexense Ltd.
The installation package is very small, 4MB - 5MB depending on the target operating system, and the product requires just 10MB of the free disk space on the target server. In order to install SysPulsar Server, start the setup program, select a destination directory and press the 'Next' button.
Optionally, enter custom server control and/or web access ports. The server control port is used by the SysPulsar command line utility to connect to the server and the web access port is the port for the web-based management interface allowing one to control SysPulsar Server using a standard web browser. If SysPulsar Server should be controlled remotely through the network, make sure one or both of these ports are open in the server's firewall.
Flexense Ltd.
SysPulsar will scan the server configuration and create a default set of system monitors appropriate for the current server hardware configuration. In order to manually add one or system monitors. press the 'Add Monitor' button located on the SysPulsar Server home page, select an appropriate monitor type and press the 'Ok' button.
Some types of system monitors provide advanced options allowing one to configure how each specific monitor is operating. In addition, SysPulsar allows one to send E-Mail notifications and/or automatically generate reports when a system monitor raises above or drops below a user-specified limit. In order to edit advanced configuration options for a system monitor, click on the monitor's 'Edit' button located in the 'Tools' column. Once finished configuring system monitors, press the 'Start All' button to start the monitoring process.
Flexense Ltd.
In order to connect to SysPulsar Server, open a regular web browser, enter the host name of the server to connect to and login using the default user name and password: admin/admin. The SysPulsar web-based management interface is a dynamic web application, which shows the current status of the server and the progress of performed operations without reloading the currently displayed web page. In order to operate properly, the web-based interface requires JavaScript to be enabled in the web browser.
Flexense Ltd.
System Monitors
SysPulsar Server provides a number of different types of system monitors allowing one to monitor the CPU usage, memory usage, disk space usage, disk activity, network activity, etc. The simplest way to setup SysPulsar Server is to use the product configuration wizard, which is capable of automatically configuring the product according to the server configuration.
The SysPulsar server configuration wizard scans the current server configuration, adds the most important system monitors and configures default error actions for the free memory monitor, the memory usage monitor and the free disk space monitor.
In order to configure a system monitor, click the monitor's 'Edit Monitor' button located in the 'Tools' column, In order to manually add one or more system monitors, press the 'Add Monitor' button located on the SysPulsar home page, select an appropriate monitor type and press the 'Ok' button.
Flexense Ltd.
In order to setup an action for a system monitor, click the 'Edit Monitor' button located in the 'Tools' column, press the 'Add Action' button, select an appropriate action type, select the history time period and the type of value to evaluate, select an operator and press the 'Ok' button. In addition, in order to enable E-Mail notifications, open the 'Settings' page and specify an SMTP E-Mail server to use to sent notifications.
Flexense Ltd.
By default, the memory usage monitor shows a warning message when the average memory usage for the last minute rises above 90%. In addition, the user is provided with the ability to change the maximum allowed memory usage and/or set a different type of action to execute or E-Mail notification to send when the memory usage rises above the user-specified limit.
In order to change the default action, click on the action link, enter the maximum allowed memory usage limit, change the action type and press the 'Save' button. In addition, in order to enable E-Mail notifications, the user needs to configure the destination e-mail address on the 'Settings - Notifications' page and an SMTP E-Mail server to use to send notifications on the 'Settings - E-Mail Server' page.
Flexense Ltd.
By default, the free memory monitor shows a warning message when the average amount of the free system memory for the last minute drops below 100MB. In addition, the user is provided with the ability to change the minimum allowed amount of the free system memory and/or set a different type of action to execute or E-Mail notification to send when the amount of the free system memory drops below the user-specified limit.
In order to change the default action, click on the action link, enter the minimum allowed amount of the free system memory usage limit, change the action type and press the 'Save' button. In addition, in order to enable E-Mail notifications, the user needs to configure the destination e-mail address on the 'Settings - Notifications' page and an SMTP E-Mail server to use to send notifications on the 'Settings - E-Mail Server' page.
Flexense Ltd.
By default, the disk space usage monitor shows statistics for the system disk. In addition, the user is provided with the ability to add one or more additional disks to be monitored by the disk space usage monitor. In order to change the configuration of the disk space usage monitor, click on the monitor's 'Edit' button located in the 'Tools' column and specify one or more disks (delimited by the semicolon character) to be monitored.
Another option is to add to the SysPulsar configuration multiple disk space usage monitors, with each one configured to monitor a different disk. This way, SysPulsar will show individual disk space usage statistics for each monitored disk.
10
Flexense Ltd.
11
Flexense Ltd.
In order to change the type of the displayed information, click on the left combo box and select an appropriate display mode. In order to change the currently displayed history time frame, click on the right combo box and select an appropriate period of time.
By default, the disk space usage monitor shows statistics for the system disk. In addition, the user is provided with the ability to add one or more additional disks to be monitored by the disk space usage monitor. In order to change the configuration of the disk space usage monitor, click on the monitor's 'Edit' button located in the 'Tools' column and specify one or more disks (delimited by the semicolon character) to be monitored.
12
Flexense Ltd.
In addition, SysPulsar Server provides the ability to automatically save status reports every X hours according to the user-specified time interval. In order to configure automatic generation of status reports, open the 'Settings - Logs and Notifications' page, enable the 'Save Status Reports' option and select an appropriate time interval.
Automatically generated status reports are saved in the SysPulsar reports directory and may be accessed on the 'Reports' page. In order to open a previously saved status report, just click on the report link displayed on the 'Reports' page. In order to save a report to one of the standard report formats, click on the report's 'Save' button in the 'Tools' column.
13
Flexense Ltd.
In addition to the ability to manually save PDF reports, SysPulsar allows one to periodically send status reports to an E-Mail address. Each status E-Mail message includes an HTML status summary and an attached PDF report file. In order to enable periodical status PDF reports, open the 'Settings - Logs and Notifications' page, select a time interval, specify an E-Mail address to send reports to and configure an SMTP server to use to send reports.
14
Flexense Ltd.
In order to set a custom user name and password, click on the 'Configure Server Login' link located on the main settings page, enter a new user name and password and press the 'Save' button.
15
Flexense Ltd.
Save Error Logs To - this option enables error reports and controls the destination directory for automatically saved error reports. For any system monitor, the user is provided with the ability to automatically generate an error report when the monitor's value drops below or rises above a user-specified limit. When SysPulsar detects an error, a report file is generated and saved in the specified directory. Send Notifications To - this option enables error notifications and controls the destination E-Mail address to send notifications to. In addition, the user needs to open the 'Settings - E-Mail Server' page and configure an SMTP E-Mail server to be used to send E-Mail notifications. Send Status Reports - this option enables periodic status E-Mail notifications and controls the status notifications time interval. Each status notification E-Mail includes a summary of the current server status and an additional attachment with a PDF report showing extended information and various types of charts for all system monitors. In addition, the user needs to open the 'Settings - E-Mail Server' page and configure an SMTP E-Mail server to be used to send E-Mail notifications. Save Status Reports - this option enables periodic generation of status reports and controls the status reports time interval. By default, status reports are saved in the SysPulsar reports directory and accessible on the 'Reports' page. SysPulsar keeps a history of status reports in the reports directory and automatically deletes old reports when new reports are saved. Check System Monitors - this option enables periodic evaluation of monitoring actions and controls the monitoring time interval.
16
Flexense Ltd.
In order to set a custom server control port and/or web access port, click on the 'Setup Server Ports' link located on the main settings page, select the 'Use Custom Port' option and enter a custom port number to use. If the SysPulsar server should be controlled through the network, make sure the custom ports are open in the server's firewall.
17
Flexense Ltd.
The command line utility may be executed with a variety of command line parameters and options allowing one to automate control, configuration and management of one or more SysPulsar Servers using batch files or shell scripts. For detailed information about available command line options, execute the command line utility with the '-help' command line parameter. SysPulsar Command Line Utility Usage:
syspulsar -status This command shows the status of all system monitors.
syspulsar -delete_all This command deletes all system monitors from the product configuration.
18
Flexense Ltd.
syspulsar -save_pdf_report [ File Name or Directory ] This command saves the current server status to a PDF report file. If the file name is not specified, SysPulsar will generate a file name containing the current date and time and save the report in the user's home directory. If an existing directory is specified, SysPulsar will generate a file name containing the current date and time and save the report in the specified directory. syspulsar -save_xml_report [ File Name or Directory ] This command saves the current server status to an XML report file. If the file name is not specified, SysPulsar will generate a file name containing the current date and time and save the report in the user's home directory. If an existing directory is specified, SysPulsar will generate a file name containing the current date and time and save the report in the specified directory. syspulsar -save_html_report [ File Name or Directory ] This command saves the current server status to an HTML report file. If the file name is not specified, SysPulsar will generate a file name containing the current date and time and save the report in the user's home directory. If an existing directory is specified, SysPulsar will generate a file name containing the current date and time and save the report in the specified directory. syspulsar -save_text_report [ File Name or Directory ] This command saves the current server status to a text report file. If the file name is not specified, SysPulsar will generate a file name containing the current date and time and save the report in the user's home directory. If an existing directory is specified, SysPulsar will generate a file name containing the current date and time and save the report in the specified directory. syspulsar -save_csv_report [ File Name or Directory ] This command saves the current server status to an Excel CSV report file. If the file name is not specified, SysPulsar will generate a file name containing the current date and time and save the report in the user's home directory. If an existing directory is specified, SysPulsar will generate a file name containing the current date and time and save the report in the specified directory. syspulsar -server_status This command shows the status of the SysPulsar service. syspulsar -server_log This command shows the SysPulsar server message log. syspulsar -clear_server_log This command clears the SysPulsar server message log. syspulsar -about This command shows version information for the SysPulsar server. syspulsar -help This command shows the command line utility usage information. syspulsar -v This command shows version information for the SysPulsar command line utility.
19
Flexense Ltd.
Due to the fact that the product is especially designed for servers running in production environments where stability is a major decision factor, SysPulsar Server updates should be manually performed by the user. In order to update an existing product installation, download the latest product version and just execute the setup program, which will detect the currently installed product version and perform a proper update procedure while keeping the current product configuration and product registration intact.
The SysPulsar Server setup program will properly shutdown the running SysPulsar Server, update the product and restart the SysPulsar service after finishing the update procedure. All product configuration files, configured system monitors and product registration will remain valid and there is nothing to reconfigure or manage after the update.
20
Flexense Ltd.
If the computer where SysPulsar Server is installed on is connected to the Internet, login to the SysPulsar web-based management interface (default user name and password: admin/admin) using a standard web browser, click on the 'About' link located on the top menu bar, press the 'Register' button, enter your name or your company name, enter the received unlock key and press the 'Register' button.
If the computer is not connected to the Internet, press the 'Manual Registration' button, export the product ID file and send the product ID file to register@syspulsar.com as an attachment. Within a couple of hours, you will receive an unlock file, which should be imported in order to finish the registration procedure.
21
Flexense Ltd.
Minimal System Configuration Supported Operating System 500 MHz or better CPU 256 MB of system memory 25 MB of free disk space
Recommended System Configuration Supported Operating System 2 GHz or better CPU 512 MB of system memory 25 MB of free disk space
22