X-Cart:X-Monitoring

From X-Cart 4 Classic
Revision as of 16:33, 8 November 2012 by Rocky (talk | contribs)
Jump to: navigation, search
X-Cart 4.5or above

Overview

X-Monitoring is a SaaS solution that integrates with X-Cart to enable 24/7/365 online monitoring of your website and X-Cart store. This service can help you minimize the period of downtime for your site to as little as several minutes. You, but not your customers, will be the first to know if your site is down or having problems.

As declared above X-Monitoring is a SaaS solution and it runs on our company's infrastructure, thus you don't have to install any 3-d party software or create accounts in any systems. All you need is to install X-Monitoring add-on to implement monitoring widget into your site. X-Monitoring service is provided on subscription basis.

Key benefits of using X-Monitoring in X-Cart

  • 24/7/365 online monitoring: We will do periodic checks of your store website to ensure that it is up and running correctly.
  • Website response measurement: If you website responses to slowly you will be notified as well.
  • Detailed availability reports: At any time you will be able to view detailed reports on the availability of your store website for the past two weeks right in X-Cart's admin area.
  • Instant email notifications: If your website is down, you will instantly receive an alert at the email address you have specified in the module settings.
  • SaaS architecture: High performance and feature updates are available automatically without the need to upgrade your client software.
  • 30-day free trial period.
  • Monthly subscription plan

How it works

As soon as you install X-Monitoring module to X-Cart store, your website is added to our monitoring system automatically and 30-day trial period starts.

Click on "Configure" link to proceed:

Configure.png

On X-Monitoring module configuration page you can check the subscription plan you are currently on, how many days left to its expiration, subscribe or upgrade your plan if necessary. The address for email notification will be automatically taken from the General settings -> Company options page (Site administrator email address). However, you can adjust it according to your needs by entering the preferred email address and applying the changes.

XMonitoring settings.png

As soon as service is launched by installing the module it starts monitoring your website and collecting data. Availability reports can be accessed via "Tools" -> "X-Monitoring service" menu in admin area.

Availability diagram

Represents X-Cart and web server availability report in diagram view

Diagram.png

Availability reports

Represents X-Cart and web server availability reports in table view with specifying time, type and reason of an issue, availability duration.

Report table.png

Email notifications

In case web server or X-Cart store is down an email notification will be sent to the address specified on the X-Monitoring module settings page. For instance, here is an email sent in case X-Cart is down:

Email notification.png

X-Monitoring integration module system requirements

To be able to successfully install and use the X-Monitoring add-on module, you need to have an installed working copy of X-Cart 4.5.0 version or later. Make sure that the version of the module is the same as the version of your installed copy of X-Cart.

Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the Environment info section of the Summary page in X-Cart Admin area.

Installation and removal

The X-Monitoring integration module installation process is the same for all X-Cart editions.

To install the X-Monitoring integration module:

  1. Obtain a distribution package for the module by downloading it from the File Area section of your X-Cart Account account or from this page: http://www.x-cart.com/extensions/modules/monitoring.html. The distribution package you need is archived in the file xmonitoring-x.y.z.tgz, where x, y and z indicate the version of the module. Make sure the version of the module matches the version of your copy of X-Cart.
  2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
    • If you use a Windows-based server or a UNIX-based server without terminal access:
    a) Extract the contents of the archive with the X-Monitoring integration module files to a directory on your system using your favorite compression program (WinZIP or any other archiver that supports TAR files).
    b) Use an FTP client to upload all the files extracted from the archive (retaining the directory structure) to the X-Cart root directory on your server or hosting account.
    • If you use a UNIX-based server with terminal access:
    a) Use an FTP client to upload the archive with the X-Monitoring integration module distribution package to the X-Cart root directory on your server or hosting account.
    b) Decompress the package using the following command:
    tar -xzvf xmonitoring-x.y.z.tgz
    Important: Make sure that you maintain the directory structure while unpacking and uploading the distribution package; otherwise, some critical files can be overwritten!
  3. In a web browser, run the installation script at httр://www.example.com/install-xmonitoring.php, replacing www.example.com with the actual domain name of your X-Cart based store.
  4. Enter the Auth code, accept the License Agreement and click the Next button.
  5. The installation script copies the files and activates the module. Click the Next button to continue.
  6. The installation script generates a new system fingerprint. Click the Next button to complete the installation.
  7. Use the ADMIN AREA link to go to the Admin area and configure X-Monitoring.

To uninstall the X-Monitoring integration module:

  1. In a web browser, run the installation script at httр://www.example.com/install-xmonitoring.php, replacing www.example.com with the actual domain name of your X-Cart based store.
  2. Choose the Uninstall the module option, enter the Auth code, accept the License Agreement and click the Next button.
  3. Once the installation script has removed the X-Monitoring integration module files and deactivated the module, click the Next button to complete the uninstallation.
  4. On the Uninstallation complete screen, click Next to leave the Wizard.
    Important: After you have uninstalled the X-Monitoring integration module, be sure to remove the X-Monitoring integration module distribution package from your web directory as well.

Enabling the X-Monitoring integration module in X-Cart

To enable the X-Monitoring integration module:

  1. In the X-Cart Admin area, go to the Modules section (Settings menu -> Modules).
  2. In the list of modules, choose the "X-Monitoring" item by selecting the respective check box on the left.
  3. Scroll down to the bottom of the page and click the Apply changes button. This activates the module.