Monitoring Your Configuration Environment

The Configuration Database is the backbone of your configuration environment. Management Framework provides several scripts that you can use to monitor the performance and the health of your Configuration Database.

Configuration Database monitoring is based on a set of scripts to retrieve statistics from the Configuration Database that you can use to determine the potential or present issues that affect the performance and health of the database and your data. The database scripts used for monitoring are distributed as part of the Configuration Database Maintenance Scripts IP, in the /tools folder. Scripts are available for the MSSQL, Oracle, and PostgreSQL Database Management Systems, and can be run on Configuration Server Database Schema version 8.1 and newer.

Each script can be run against the Configuration Database at any time without stopping Configuration Server or restricting its access to the database.

Each script generates CSV-formatted output containing key metrics, and includes a header. The output can be used for further analysis, using tools that allow CSV processing, such as Microsoft Excel. You can view the output on screen, in a text editor, or import it into an application that displays the file in a spreadsheet, such as Microsoft Excel. You can also search for, and view, objects using Genesys Administrator.

The following performance scripts are available:

• csv_objtype_sizes.sql—This script calculates usage for major types of configuration objects.
• csv_largest10_objbytype.sql—This script enables you to determine if any particular object of a given type is significantly larger than the others.
• csv_biggerthan_objbytype.sql—This script helps you identify the number of configuration objects per object type that impact performance the most, and/or are out of the range of expected size for this type.

Refer to Monitoring Performance of Configuration Environment for more information about these scripts.

The following health monitoring scripts are available:

Refer to Monitoring Health of Configuration Environment for more information about these scripts.

Limitations

The scripts do not support the following:

• Configuration Database version 8.1 or earlier with a non-English locale
• PostgreSQL DBMS prior to version 9.0

Running the Configuration Database Monitoring Scripts

The scripts can be executed using DBMS utilities or from the command line.

Using DBMS Utilities

Run the script using the corresponding DBMS utility, as follows:

• MSSQL scripts: Microsoft SQL Server Management Studio 2005 or newer
• Oracle scripts: Oracle SQL Developer 1.5 or newer
• PostgreSQL scripts: pgAdmin III 1.12 that supports Postgre 9.0 or newer

The script output appears on the console. Capture the output and save it as a .csv file, suitable for further analysis.

From the Command Line

The Configuration Database Maintenance Scripts IP also contains command-line scripts for Windows (MS SQL, Oracle, and Postgre databases) and Linux (Oracle and Postgre databases) operating systems. Each command-line script runs the three SQL scripts, and writes the output to a .csv file in a specified results directory. This directory must exist before running the command-line script.

Each command-line script generates three .csv report files, as follows:

• csv_biggerthan_objbytype_<DBMS_TYPE>.csv
• csv_largest10_objbytype_<DBMS_TYPE>.csv
• csv_objtype_sizes_<DBMS_TYPE>.csv

The command-line scripts are listed in the following table.

DBMS	Operating System
	Windows	Linux
Windows MS SQL Server	\mssql\monitor_MSSQL_DB.bat	Not available
Oracle	\oracle\monitor_ORACLE_DB.bat	/oracle/monitor_ORACLE_DB.sh
Postgre a	\postgre\monitor_POSTGRE_DB.bat	/postgre/monitor_POSTGRE_DB.sh
a For Postgre scripts, configure the PostgreSQL server to allow a client connection with the host on which the scripts are run.

Command Syntax

Run the script from the folder in which it is located.

The syntax of a command-line script is as follows:

<script> <USER> <PASSWORD> [<HOST> <PORT> or <HOST[\INSTANCE]>] [<SERVICE_NAME> or <DB_NAME>] <CSV_RESULT_DIR>

where:

• <script> is the name of the script, as provided in the table above.
• <USER> is the name of a user authorized to access the database.
• <PASSWORD> is the password required for the authorized user to access the database.
• <HOST> is the name of the host on which the database is located.
• <PORT> is the number of the port on that host that is used by the DBMS.
• <HOST\INSTANCE> is the database host and instance, if not the default.
• <SERVICE_NAME> is the Oracle Instance Service Name, that is, the SERVICE_NAME value in TNSNAMES.ORA.
• <DB_NAME> is the name of the Database.
• <CSV_RESULT_DIR> is the path to the directory in which the output .csv files will be stored.

Tip

To see the syntax on-line, with no values for parameters, enter the script name and press ENTER.

Examples:

MS SQL Server

.\monitor_MSSQL_DB.bat sa password localhost\SQLEXPRESS TestDB D:\MF_mon\results\mssql
.\monitor_MSSQL_DB.bat sa password somehost SomeTestDB D:\MF_mon\results\mssql

Oracle

./monitor_ORACLE_DB.sh sourcedb sourcedb localhost 1521 orcl.genesys.com '/home/genesys/results/oracle'

Postgre

./monitor_POSTGRE_DB.sh postgres password localhost 5432 TestDB '/home/genesys/results/postgre'

Viewing the Script Output

The output of the scripts can be viewed in several ways:

• Display the output on your screen.
• Save the output to a .csv file and open it in a text editor.
• Save the output to a .csv file and import it into a spreadsheet, such as Microsoft Excel.
• Save the output to a .csv file and upload it into Genesys Administrator, as described below.

Viewing Script Output in Genesys Adminsitrator

You can upload the .csv file into Genesys Administrator version 8.1.309.02 or later. You can then click any object in the list to view the object itself, searching for it if necessary. You can also filter the list by object name and/or type and export it to another .csv file. Use the following steps:

Step 1: Upload the file and display it

To upload the file generated by the scripts, set the new search-by-csv-file-mode option to true in the new [SpecialSearchProperties] section of the Genesys Administrator object. Then, in Genesys Administrator, navigate to Provisioning > Search, click Choose File, and select the file. Click the Search button to display the contents of the file.

[+] Show option description

search-by-csv-file-mode
Default Value: false
Valid Values: true, false
Changes take effect: After logging out of Genesys Administrator

Specifies whether the Choose File button appears in the Search window in the Provisioning module. If set to true and you are logged in to Genesys Administrator, use this button to upload the file into Genesys Administrator.

Step 2: Export results to another file.

To export search results to another .csv file, set the new search-to-csv-export-mode option to true in the same section of the Genesys Administrator object, then click Export.

[+] Show option description

search-to-csv-export-mode
Default Value: false
Valid Values: true, false
Changes take effect: After logging out of Genesys Administrator

Specifies whether the Export button appears in the Search window in the Provisioning module. If set to true, and you are logged in to Genesys Administrator, use this button to export the results of a search of the output of the Configuration Database Monitoring scripts, to another .csv file.

Tip

You can also use this option and the Export button to export the results of a search of the Configuration Database (by Object Name and Object Type) to a .csv file.