Prerequisites

Prior to installing Evident ClearStone Live for Java, ensure the following prerequisites are met:

1. JMX instrumentation

• Identify the JVMs that need to be monitored. Ensure the host, JMX port #, and credentials for each are available.
• For custom Managed Beans, ensure the Managed Beans are registered within the code. The developer must provide a list of the MBean object names/patterns for the collection configuration.
  

2. ECSL JMX Collector Deployment

• If the JVMs are running on a different network than the ECSL server, consider deploying a remote ECSL JMX Collector that is within the same network. The benefit would be to reduce network overhead across multiple network segments and improve overall collection latency.
• If the JVMs are J2EE containers, consider deploying the Evident JMX Proxy Servlet web application. This provides a HTTP based interface to collect data from the J2SE container and avoids using standard JMX over RMI, which tends to be slow. Furthermore, HTTP is generally open on most hosts and networks, whereas RMI may not be.
• If the JVMs are standard Java processes, then configure the collector for JMX Remote.
• A single Collector can collect from multiple JVMs using either approach.

3. ECSL Operational Cache

• The OpCache is limited to the available physical memory across the ECSL core server(s). With more physical memory ECSL, can retain the more real-time performance data and events for longer periods of time. Typically, the OpCache is used to store the most recent 24 hours of real-time.
• Consult Evident Software regarding the sizing of the OpCache to ensure the amount of physical memory is adequate for the monitoring of the environment.
  

4. Database Requirements

• A relational database is required for storing historical data for ChronoGraphs.
• Only Oracle 10g/11g is supported.
• Customers are required supply a separate database instance running on a database-grade server.
• For production, the DBA should ensure the database instance is properly configured with tablespaces to achieve optimal performance.
• ECSL includes tools for creating the database schema and ETLs necessary for the data warehouse.
  

5. Notifications

• ECSL supports email and SNMP trap alerts.
• For email alerts, the administrator must have a SMTP host and list of email addresses subscribing to the alerts.
• For SNMP traps, the administrator must have one or more SNMP trap destinations available.
• For additional custom alerting interfaces, this can be supported via a custom notfication plugin.

Deployment Scenarios

The ECSL installation consists of deploying the software on one or more servers. The product can be deployed across multiple servers to scale out data storage and load balancing the real-time data processing. Optionally, customers can deploy remote Collectors and Management Plugin Server collect and manage the remote applications. During the installation process, administrator are presented with the following options:

• Collector
• Pipeline Server
• User Interfaces
• Management Framework
• ChronoGraph (license specific)

The ECSL license controls what additional features to enable in the product installation. If the specified ECSL license includes support for additional Management Packs, the installer will automatically deploy components for the management packs. For example, the Oracle Coherence Management Pack includes the following additional components:

• Oracle Coherence Information Model
• Oracle Coherence Plugins and Extensions
• Real-Time Console for Oracle Coherence

During the installation process, the following modules are available for installation. The product can be deployed on a single server or across multiple servers to support large scale environments.

Base on the desired deployment model, follow these guidelines for installation of the software on the target platforms.

• For installations supporting Oracle Coherence, a valid ECSL license is required for the Coherence Management Pack.
• For deploying ECSL on a single server, choose to install all options.
• For deploying ECSL with a remote collector, perform these steps:
  • Start with the deployment of the JMX Collector and Management Plugin Server on server #1.
  • On the ECSL core server, choose the Pipeline Server, User Interfaces, and ChronoGraph (if licensed).
• For deploying multiple ECSL servers, perform these steps:
  • Start with the deployment of the JMX Collector and Management Plugin Server on server #1.
  • Next, deploy the first ECSL core server by choosing the Pipeline Server option.
  • Lastly deploy the second ECSL core server by choosing the User Interfaces and ChronoGraph option(s).
  • For this deployment model, ensure the two ECSL core servers are same network segment.
• The ChronoGraph module requires a separate Oracle database server.
  

Installing on MS Windows Platforms

1. Ensure the server meets the system requirements as described in the System Requirements section.
2. Obtain a valid license file from Evident Software.
3. Installation must be performed by a user with Administrator rights on the target host.
4. Upload the installer (install.exe) and the license file to the server.
5. Run install.exe on the command line or using Windows file explorer.
6. The installer will prompt for the target installation directory on the server. The designated drive requires at least 2GB of disk space.
7. The installer will prompt the user for the ECSL license file. Please provide the name of the licensee and the absolute path where the license file is located. Once all the information has been specified, click on the Install License button to install the license key and then proceed using the Next button.
8. Following the license registration, the installer will prompt for the acceptance of the Electronic User License Agreement for the software.
9. Base on the deployment model as noted above, select the modules as required. After the module selection is completed, continue with the installer. It will deploy the product in the specified directory.
10. On the ECSL core server(s), the installer creates two Windows services entries for Evident ClearStone Live and the Evident ClearStone OpCache Manager. The Evident ClearStone Live service depends on the Evident ClearStone OpCache Manager service. Both are set to auto start upon a server restart.
11. If the Collector is deployed on a remote host, the installer creates a single Windows service (Evident ClearStone Live for Java 4.x.).
12. For additional server deployments, repeat the same steps choosing the appropriate options to deploy.
13. Once the service is running, open a browser to http://<server>:8080, where <server> is the hostname where the product was installed. Proceed with Setup and Configuration documentation.

Installing on Linux or Solaris

1. Ensure the server meets the system requirements as described in the System Requirements section.
2. Obtain a valid license file from Evident Software.
3. Upload the installer (install.bin) and license file to the server.
4. Where possible, install the product as a user with root privileges. If the installation is executed by a user without root privileges, then the installer will warn the user of this restriction. It will proceed to install, however it will not deploy the startup scripts for the Evident ClearStone Live services in the /etc/init.d directory. The ownership can be changed from root to another user after the installation is completed.
5. Open up a shell and run the installer. The installer runs in console mode.
   # sh install.bin
   
6. It will prompt for the target installation directory on the server. The designated drive requires 2GB of disk space. The directory will automatically be created.
7. When the installer prompts for the license file, enter the name of the licensee and the absolute path where the license file is located. Once all the information has been specified, the installer will validate the license and continues with the installation is accepted.
8. Following the license registration, the installer will prompt for the acceptance of the Electronic User License Agreement for the software.
9. The installer will prompt for the modules to install. Base on the deployment model as noted above, enter "yes" for the modules as desired.
10. Once all the modules are selected, the installer will proceed to install the software.
11. Assuming the installation was executed as a user with root privileges, the installer will create additional startup scripts that will run the software on the host.
• On the server where the Pipeline Server or User Interfaces is installed, the installer creates the following startup scripts:
  - /etc/init.d/evidentws (Evident ClearStone Live daemon)
  - /etc/init.d/evidentocm (Evident ClearStone OpCache Manager daemon)
• On the remote server where the JMX Collector is deployed, the installer creates a single startup script:
  - /etc/init.d/evidentws (Evident ClearStone Live daemon)
12. For additional server deployments, repeat the same steps choosing the appropriate modules to deploy.
13. Assuming the installation was executed as a user with root privileges, it is recommended to change the file ownership of the installed software and startup scripts. Follow these steps:
    • Stop the service(s):
      # /etc/init.d/evidentws stop
      # /etc/init.d/evidentocm stop
    • If required, create a new user group for the new user account (i.e. evident).
    • Create a new user (i.e. evident) using User Administrator tool or useradd command. Specify the new user group is desired.
    • Change the ownership of the files where the product was installed to the new user. For example:
      # chown -fR evident:evident /opt/evident/ECSL
    • Login or su to the new user (i.e. evident) and start the services:
      # su - evident
      $ /etc/init.d/evidentocm start
      $ /etc/init.d/evidentws start
14. Once the service is running, open a browser to http://<server>:8080, where <server> is the hostname where the product was installed. Proceed with Setup and Configuration documentation.

Installing on Apple Mac OS X

1. Ensure the server meets the system requirements as described in the System Requirements section.
2. Copy the installer (install.app) to the host where the Evident ClearStone Live software is to be installed.
3. If possible, install the product as a user with root privileges. If the installation is executed by a user without root privileges, then the installer will warn the user of this limitation. It will proceed to install, however it will not deploy the startup scripts for the Evident ClearStone Live services (the services can be started manually, see Step #10 below).
4. Double-click on the install icon from the Finder to launch the Evident ClearStone Live installer and follow the directions provided by the installer.
5. If you get and error that specifies that "you do not have sufficient permissions to install services on this machine", click-on the Next button and proceed with the installation.
6. The installer will prompt for the target installation folder on the Mac. The designated drive requires 2GB of disk space. The default installation is in /Applications/ClearStone_Live/ directory, but you may select a different folder from the default Applications folder, if needed, by selecting the Choose button.
7. The installer will proceed to prompt for the license file. When prompted, provide the Customer Name of the license key and the absolute path where the license file is located (you can browse using the "..." button). Once all the information has been specified, click on the Install License button to install the license key and then proceed using the Next button.
8. Following the license, the installer will prompt for the acceptance of the Electronic User License Agreement for the software.
9. After the feature selection is completed, continue with the installer. It will deploy the product in the designated installation Folder. Click on the Done button once Evident ClearStone Live has been installed successfully.
10. If you received the "you do not have sufficient permissions to install services on this machine" message in Step #5, you can manually start the services using the instructions below or install the services from an account that has root privileges as stated below.

Evident OpCache Manager

These instructions assume Evident ClearStone Live is installed in the default location, /Applications/ClearStone_Live. To start the Evident OpCache Manager manually, open the Mac OS X Terminal application from the Application --> Utility folder and perform the following steps from a command prompt:

• $ cd /Applications/ClearStone_Live/services/EvidentClusterManager/bin
• $ ./evidentocm.sh start

To install and start the Evident Opcache Manager service, log in as root and perform the following steps from a command prompt:

• # cd /Applications/ClearStone_Live/services/EvidentClusterManager/bin
• # cp evidentocm.plist /Library/LaunchDaemons
• # launchctl load /Library/LaunchDaemons/evidentocm.plist
• # launchctl start com.evidentsoft.ocm

Evident ClearStone Live

To start Evident ClearStone Live manually, perform the following steps from a command prompt:

• $ cd /Applications/ClearStone_Live/tomcat/bin
• $ ./evidentws.sh start

To install and start Evident ClearStone Live as a service, log in as root and perform the following steps from a command prompt(*):

• # cd /Applications/ClearStone_Live/tomcat/bin
• # cp evidentws.plist /Library/LaunchDaemons
• # launchctl load /Library/LaunchDaemons/evidentws.plist
• # launchctl start com.evidentsoft.ws