Evident ClearStone® Live 4.5  

 

 

 

 
Evident ClearStone® Live Configuration Procedures

The following steps guides the administrator thru the post-installation configuration process of the ECSL OpCache and database.

Part 1. Operational Cache Setup

The Operational Cache is an in-memory distributed cache that is used to store all the collected and processed performance metrics and events. It can span across multiple ECSL servers. By default, it relies on both multicast and unicast network communication across ECSL servers. The default multicast IP address is 224.3.3.3 port 33389.

In the event the default multicast address needs to be modified, please follow this procedure to configure an alternative multicast address on each ECSL server. Otherwise proceed to the next configuration task.

  1. Click on the OpCacheUtil link to access the OpCache Utility tool.
  2. In the Network Configuration section, provide the new multicast address and port #.
  3. Click “Save”

If the deployment involves multiple ECSL Servers, the servers will be able to detect the presence of each other on the same local network. If the network prohibits the use of multicast, then the OpCache will need to be configured for unicast communication only.

Note: Please consult Evident Software Support wiki for further instructions for updating OpCache configuration for multi-server environments or non-multicast environments.


Part 2. Database Setup for ChronoGraphs

The ChronoGraph feature requires connecting to a remote Oracle 10g/11g database. The customer is expected to provide the database instance for ECSL. This database (known as ClearBase) will be configured as data warehouse to store historical performance data processed by ECSL. For production use, it’s crucial to configure the data warehouse properly to ensure optimal performance and efficiency. The pre-requisites are:

  • Oracle 10g or 11g Enterprise Edition
  • Refer to the following table for minimal tablespace sizing for the database.

Disk 1 Disk 2 Disk 3
Non-Production DB 1.5 GB N/A N/A
Production DB PIPELINE (200MB) FACT (1GB) DIM (100MB) FACT_IDX(1GB) DIM_IDX(50MB)

The process of setting up the database involves the following database administration steps:

  1. Create the tablespace(s) required for the database
  2. Create database user account with specific privileges
  3. Configure database tuning parameters
  4. Database creation

Step 1. Create Tablespaces

The ClearBase data warehouse is designed to take advantage of multiple tablespaces to optimize data access performance and storage. It’s expected that these tablespaces and the data files are spread across multiple disks (local or SAN). It is up to the discretion of the database administrator to determine proper physical placement of data files to maximize their desired performance and storage capacity.

ECSL includes a script for creating tablespaces for this database. This can be found in <install_dir>/ClearBase/Oracle/db_create_tablespaces.sql.

create tablespace PIPELINE nologging
datafile 'pipeline_01.dbf'
size 50M autoextend on
next 10M maxsize 500M
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

create tablespace FACT
datafile 'fact_01.dbf'
size 5G autoextend on
next 500M maxsize 18G
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

create tablespace FACT_IDX
datafile 'fact_idx_01.dbf'
size 50M autoextend on
next 10M maxsize 1G
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

create tablespace DIM
datafile 'dim_01.dbf'
size 5M autoextend on
next 5M maxsize 20M
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

create tablespace DIM_IDX
datafile 'dim_idx_01.dbf'
size 5M autoextend on
next 5M maxsize 15M
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

Beyond the tablespaces for the data storage of the historical data, it is imperative that the undo/logging data files and the temporary data file groups are on separate disk from the data warehouse data files.

Note: If any of these requirements are not met, the performance of ClearBase can greatly affect the efficiency and performance of the product.

Step 2. Create Database User

The database administrator is required to create a user account (i.e. evident) with the following privileges:

  • CREATE MATERIALIZED VIEW
  • CREATE PROCEDURE
  • CREATE SEQUENCE
  • CREATE SESSION
  • CREATE TABLE
  • CREATE TRIGGER
  • ON COMMIT REFRESH
  • QUERY REWRITE

If possible, allow the account the ability to create/extend the tablespaces, the user will need additional privileges:

  • CREATE TABLESPACE
  • UNLIMITED TABLESPACE (assuming there are no tablespace quotas)

Step 3. Configure Database Tuning Parameters

The following initialization parameters are the minimal requirements for the database:

Parameter

Value

db_block_size

8192

sga_max_size

1024M

pga_aggregate_target

192M

cursor_sharing

SIMILAR

sga_target

576M

star_transformation_enabled

TRUE

query_rewrite_enabled

TRUE

query_rewrite_integrity

enforced

workarea_size_policy

auto*

* if manual, then sort_area_size must to be set to at least 32MB

Step 4. Create ClearBase Database

ECSL employs the use of Apache Ant to create the data warehouse (ClearBase). The <install_dir>/ClearBase directory contains two configuration files (ClearBaseDDL.xml and ClearBaseDDL.properties) for the database configuration. These files require manual update based on the database environment created for ECSL.

In the ClearBaseDDL.properties file, update the following properties:

Property

Description

db.jdbc.url

Update the connection parameters for the database.

db.user

Database username

db.user.password

Database password

Before running the following installation scripts, ensure the following:

  1. The new database account and connection information works with other database tools like SQL Developer, Toad, SQuirreL, etc.
  2. The ECSL server can reach the remote database server.
  3. The ECSL server has been installed with the ChronoGraph option. If not, the database setup files will not be installed.

Please ensure that the Ant builder that comes packaged with ECSL is in the PATH. To add the ant library to your PATH execute the following:

On Windows (assuming the product is installed on c:\ECSL):

  • C:\>cd c:\ECSL\ClearBase\Oracle
  • C:\>set PATH=c:\ECSL\tools\ant\bin;%PATH%

On Linux (assuming the product is installed on /home/evident/ecsl):

  • $ cd /home/evident/ecsl/ClearBase/Oracle
  • $ export PATH=/home/evident/ecsl/tools/ant/bin :$PATH

On Apple Mac OS X (assuming the product is installed on /Applications/ClearStone_Live):

  • $ cd /Applications/ClearStone_Live/ClearBase/Oracle
  • $ export PATH=/Applications/ClearStone_Live/tools/ant/bin:$PATH

Creating ClearBase with Existing Tablespaces

If the database administrator has already created the tablespaces for the data warehouse, run the following command to install the data warehouse. If the tablespaces are not created, skip this command.

On Windows:

C:\ECSL\ClearBase>ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties

On Linux:

$ ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties

On Apple Mac OS X:

$ ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties

Creating ClearBase with New Tablespaces

If the database administrator provided a user account with tablespace privileges, the <install_dir>/ClearBase/db_create_tablespaces.sql script will need to be updated with the data file information before the tablespaces are created. This requires knowledge of the available disks on the database server to configure the location of the data files. The db_create_tablespaces.sql script (see above) will create five tablespaces (PIPELINE, DIM, DIM_IDX, FACT, FACT_IDX) in five data files. For each tablespace, update the data file location with the appropriate location on the database server’s file system.

[db_create_tablespaces.sql]

create tablespace PIPELINE nologging
datafile '<disk1_path>/pipeline_01.dbf' /* Disk 1 */
size 200M autoextend on
next 50M maxsize 300M
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

create tablespace FACT
datafile '<disk2_path>/fact_01.dbf' /* Disk 2 */
size 1G autoextend on
next 200M maxsize 2G
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

create tablespace FACT_IDX
datafile '<disk3_path>/fact_idx_01.dbf' /* Disk 3 */
size 1G autoextend on
next 200M maxsize 2G
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

create tablespace DIM /* Disk 2 */
datafile '<disk2_path>/dim_01.dbf'
size 25M autoextend on
next 5M maxsize 100M
EXTENT MANAGEMENT LOCAL
SEGMENT SPACE MANAGEMENT AUTO;

create tablespace DIM_IDX
datafile '<disk3_path>/dim_idx_01.dbf' /* Disk 3 */
size 50M autoextend on
next 10M maxsize 100M
EXTENT MANAGEMENT LOCAL

SEGMENT SPACE MANAGEMENT AUTO;
  • The only values that should be updated is the path of the first data file, the initial size, the next extend size, and the maxsize of the tablespace. Follow the physical mapping of tablespaces as listed above in database sizing matrix displayed in the pre-requisites (see above).
  • The initial size, next extend size, and maxsize are all set to the minimal recommended settings. If changes are required only increase these values, but do not decrease them.
  • The PIPELINE tablespace is set to nologging for the specific reason that ECSL employs its own recovery method for incoming data. In the event of any error (i.e. loss of connection), the ECSL database published will clear the pipeline data and retry until the batch is successful. Therefore, there is no need to log the batch data load coming into the PIPELINE tablespace.

Once this script has been updated and verified by the database administrator, run the following command to install the data warehouse with these tablespace settings.

On Windows:

  • C:\ECSL\ClearBase>ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties install_with_tablespaces

On Linux:

  • $ ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties install_with_tablespaces

On Apple Mac OS X::

  • $ ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties install_with_tablespaces

Step 5. Removing ClearBase

To remove ClearBase, execute the following command:

On Windows:

  • C:\ECSL\ClearBase>ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties drop

On Linux:

  • $ ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties drop

On Apple Mac OS X:

  • $ ant –buildfile ClearBaseDDL.xml –propertyfile ClearBaseDDL.properties drop

This operation removes all tables, stored procedures, objects, and data from the database instance. However, the database administrator will need to drop the entire database from the server.

 

Part 3. Custom Mbean Monitoring

Evident Software provides additional management packs for monitoring various applications. These all include additional information models that can be used for data collection and monitoring. Beyond these pre-built information models, customers and partners have the option to create new information models for supporting custom Mbeans. ECSL supports the monitoring of custom Manage Beans from any JVM. Information models are created using the Information Model Builder.

Information Models are organized by families of one or more heterogenous type models. There can be multiple families of information models configured with ECSL. Information Models are managed by the Information Model Builder. Within a family, there can be multiple type models that are designated as collection types that are used for data collection from the JMX sources. The collection types would contain references to the MBean’s object names/patterns and Mbean attributes. Further transformations can be applied to these collection types by creating additional derived types and/or aggregated types.

Once the information model is published to all the ECS servers, the Admin Console can be used to configure the Collection Configuration as demonstrated in the previous examples.

 


 

Copyright © 2007-2010 Evident Software, Inc. All Rights Reserved.