Configuring Engine Instrumentation

Last published : Jul 27, 2026
The GridServer Manager can use the engine_ins table, which contains details of the Engine balancing process.
Related information

Engine Instrumentation Requirements

To configure a database for Engine Instrumentation, you must have a supported third-party database. For a list of supported databases, see the readme file included with TIBCO DataSynapse GridServer® Manager.

To Configure Engine Instrumentation

To configure Engine Instrumentation, you must perform the following steps:
  1. Install the GridServer Manager and the GridServer Engine
  2. Task B Configure the Manager(to use the database)
  3. Restart the Manager (The JDBC JAR file is picked up by the Manager only after a restart.)

Task A Configure the Database

  1. Verify that the engineins.tables.<db>.sql file needed by the engineins script is in the DS_MANAGER/webapps/livecluster/WEB-INF/etc/db directory.
  2. Set the CLASSPATH on the Manager to include the necessary database driver JAR files applicable to your database. For example, for an SQL Server database in a UNIX shell, you can set the CLASSPATH as follows:
    export CLASSPATH=JDBCDriver/msbase.jar:JDBCDriver/mssqlserver.jar:\JDBCDriver/msutil.jar
    Replace JDBC Driver with the actual path to your driver JAR files.
  3. Run the engineins script, located in the DS_MANAGER/webapps/livecluster/WEB-INF/etc/db directory on your Manager. Specify the name of the database properties file as an argument to the script.
    Note:
    Before running the engineins script, ensure the property file settings are updated to match your database configuration.

Task B Configure the Manager

  1. Log in to the GridServer Administration Tool with an account that has a Security Role with the Manager Configuration Edit feature enabled.
  2. Go to Admin > System Admin > Manager Configuration > Services > Engine Instrumentation.
  3. Configure the values in the Engine Instrumentation section on Primary Director by using the appropriate values given in the following table:
    Note that the hostname is the name of the host and dbName is the name of the database.\
    Property Value
    Oracle
    Database URL jdbc:oracle:thin:@hostname:1521dbName
    Database Driver oracle.jdbc.OracleDriver
    Microsoft SQL Server
    Database URL jdbc:sqlserver://hostname:1433;DatabaseName=dbName; SelectMethod=cursor (SelectMethod=cursor is required)
    Database Driver com.microsoft.sqlserver.jdbc.SQLServerDriver
    PostgreSQL
    Database URL jdbc:postgresql://hostname:5432*/dbName*
    Database Driver org.postgresql.Driver
  4. Copy the corresponding JDBC driver's JAR file to the following Manager's directory: DS_MANAGER/webapps/livecluster/WEB-INF/lib.
  5. Restart the GridServer Manager.
To view the data, you require an account that has Security Role with the Engine Instrumentation feature enabled. The data can be viewed from the UI at Diagnostics > Engine Instrumentation.
On the Director
Here, you can see two Brokers: 1358717965 and 1956710939 and related information.
On the Broker
Here, the Broker 1358717965 contains only the data specific to it.