Configuring the Server

You can configure the database settings, schema settings, threadpool, JMS settings and so on of the server.

Procedure

  1. The following steps help you launch the Configure TIBCO Service Performance Manager Server wizard:
    1. Navigate to TIBCO_HOME/tct/<version>, and run TIBCOConfigurationTool to launch TIBCO Configuration Tool.
    2. Select a TIBCO configuration folder. The TIBCO configuration folder stores configuration data generated by TIBCO products. Configuration data can include sample scripts, session data, configured binaries, logs, and so on. If you want, you can change the default location of this folder.
    3. Click Configure TIBCO Service Performance Manager Arguments -V2.2.
    4. Click Configure TIBCO Service Performance Manager Server and click Next.
  2. Use the properties mentioned in the following table to configure the database and click Next when you are done.
    Table 1. Database Configuration Properties
    Field Name Property in

    spm-config.

    properties

    Mandatory Default Value Description
    Database Driver rta.jdbc.driver Yes org.postgresql.Driver Specify the name of the JDBC driver
    Database URL rta.jdbc.url Yes jdbc:postgresql://

    localhost:5432/database

    Provide the location of the database server.

    See the documentation specific to your JDBC driver for more information.

    Username rta.jdbc.user Yes spm_user The username that the Service Performance Manager server uses to access the database.

    This user must have read and write permissions to the database.

    Password rta.jdbc.password Yes   The password that the server uses, in conjunction with the username provided in dbstore_driver_username, to access the database
  3. (Optional) Select Advanced Options to configure advanced database options.
    Note: If you do not select Advanced Options, the advanced properties take default values. However, if you use Advanced Options, the properties take the last configured values.
    1. Provide the following values, and click Next.
      Table 2. Database Configuration Advanced Properties
      Field Name Property in spm-config.properties Mandat

      ory

      Default Value Description
      Initial Connections rta.jdbc.initial.connection.size No 10 The number of connections allowed at initialization
      Max Connections rta.jdbc.max.connection.size No 100 Specifies the maximum number of simultaneous client connections to the database
      Transaction Batch Size rta.jdbc.batch.size No 1000 Specify the database batch size
      JDBC Key rta.jdbc.key No "" Database connection pool internal identifier

    2. (Optional) To test the validity of the connection, click Test Connection. To do so, specify the JDBC Driver Path. You should make available the driver jars for the database that you choose, and specify the full path of this jar file here. TIBCO Configuration Tool modifies the server's classpath in the specified ".TRA" file.
    3. Click Next.
  4. Use the properties mentioned in the following table to configure JMS and click Next when you are done.
    Table 3. JMS Configuration Properties
    Field Name Property in spm-config.properties Mandat

    ory

    Default Value Description
    Context Factory rta.jms.jndi.contextfactory No com.tibco.tibjms.naming.Tibjms

    InitialContextFactory

    JMS Transport JNDI context factory
    Provider URL rta.jms.jndi.url No tibjmsnaming://localhost:7222 JMS provider URL
    Username rta.jms.connection.username No admin JMS provider connection username.
    Password rta.jms.connection.password No   JMS provider connection password. The default value is the obfuscated value of <BLANK>,

    Note that it is not a single blank space character.

    1. (Optional) Select Advanced Options to configure advanced JMS options. Provide the following values and click Next.

Table 4. JMS Configuration Advanced Properties
Field Name Property in spm-config.

properties

Mandat

ory

Default Value Description
Queue Connection Factory rta.jms.

queueconnectionfactory

No SPMQueue

ConnectionFactory

JMS queue connection factory
Inbound Queue rta.jms.inbound.queue No spm.inbound.queue JMS inbound queue for the Service Performance Manager server to receive messages
Outbound Queue rta.jms.outbound.queue No spm.outbound.queue JMS outbound queue for the Service Performance Manager server to send messages
Inbound Query Queue rta.jms.inbound.query.queue No spm.inbound.

query.queue

JMS inbound query queue for Service Performance Manager server to receive messages.
Fault Tolerance Queue rta.ft.queue.name No spm.ft.queue This is the queue on which the Service Performance Manager server exchanges messages related to fault tolerance. The Service Performance Manager Client API does not use this queue.
Retry Interval rta.jms.connection.retry.interval No 5000 JMS connection retry interval. Time interval in milliseconds for retrying a failed JMS connection.
Outbound Message Expiry rta.jms.outbound.

message.expiry

No 432000000 JMS message expiration in milliseconds for outbound messages from the Service Performance Manager server.
  1. Use the properties mentioned in the following table to configure the Threadpool and click Next when you are done.
    Table 5. Threadpool Configuration Properties
    Field Name Property in spm-config.properties Mandat

    ory

    Default Value Description
    Common Threadpool Size rta.worker.thread.count No 32 The number of worker threads for the common thread pool
    Metric Compute Threadpool Size rta.metric.compute.thread.count No 32 Number of threads to perform the core computation jobs. Each hierarchy computes on a single thread.
  2. (Optional) SelectAdvanced Options to configure advanced Threadpool options. Provide the following values and click Next.
    Table 6. Threadpool Configuration Advanced Properties
    Field Name Property in spm-config.properties Mandat

    ory

    Default Value Description
    Common Threadpool Queue Size rta.worker.queue.size No 64 The queue size for the common thread pool
    Metric Compute Threadpool Queue Size rta.metric.compute.queue.size No 64 Queue size for the metric thread pool. Change it only when you change rta.metric.compute.thread.count. A value twice the queue thread size is recommended.
    Common Threadpool Minimum Threads rta.worker.thread.count.min No 0 The minimum number of threads to retain in the thread pools even when there is less load on them. This value should be less than or equal to rta.worker.thread.count.
    Common Threadpool Idletimeout rta.worker.thread.idle.timeout No 300 Time interval in seconds after which idle threads of the thread pools are stopped, till the thread count reaches the rta.worker.thread.count.min setting.

  1. Use the properties mentioned in the following table to configure the server and click Next when you are done.
    Table 7. Server Configuration Properties
    Field Name Property in spm-config.

    properties

    Mandat

    ory

    Default Value Description
    Schema Store Location rta.schema.store No SPM_HOME/config Location on the file system where the server loads the schema files.
    L1 Cache Size rta.l1.cache.size No 10000 Size of the L1 cache used to store metric nodes. L1 cache ensures that frequently used data is cached inside the JVM and hence not loaded from the database. The L1 cache uses an LRU algorithm.
    1. (Optional) Select Advanced Options to configure advanced server options. Provide the following values and click Next.
      Table 8. Server Configuration Advanced Properties
      Field Name Property in spm-config.properties Mandat

      ory

      Default Value Description
      Server Batch Size rta.server.batch.size No 100 Client batches further are batched on the server for processing, for enhanced performance. This property specifies the batch size to use on the server.
      Server Batch Size Flush Period (ms) rta.server.batch.flush.period No 5000 Time interval in milliseconds to wait for a server batch to complete. Incomplete batch is still processed at this interval.
      Rule Metric Node Cache Size rta.l1.cache.size.rule.metric.nodes No 10000 Size of the L1 cache used to store rule/action state nodes. Larger cache with appropriately large JVM heap (-Xmx setting ) results in better performance.
      Session Heartbeat Threshold (ms) rta.config.session.heartbeat.threshold No 60000 Maximum time in milliseconds that a named session can be kept alive, since the last heart beat from client is received.
      Snapshot Query Timeout rta.snapshot.query.timeout No 300000 Defines timeout in milliseconds for expiration of snapshot query. If the query is not accessed for the specified duration, it expires after the specified period.
      Rules Actions Scan Frequency rta.rules.actions.scan.frequency No 5000 Specifies in milliseconds how often to scan for scheduled actions,
  2. Use the properties mentioned in the following table to configure storage and recovery and click Next when you are done.
    Table 9. Storage and Recovery Configuration Properties
    Field Name Property in spm-config.

    properties

    Mandat

    ory

    Default Value Description
    Store Facts rta.store.facts No false Whether to store the facts into the database. For a very high transaction rate, setting this property to false helps improve the performance.

    Since Service Performance Manager 2.2.0 relies on EMS for recovery, it is not necessary to store these facts. One may still need to store them for business reasons.

    Process Duplicate Facts rta.process.duplicate.

    facts

    No true Defines whether to process or skip duplicate facts. Applicable only when rta.store.facts=true. Else this has no effect.

    When set to true, reprocess a possible duplicate fact.

    When set to false, skip over a possible duplicate fact.

  3. Use the properties mentioned in the following table to configure mail and log and click Next when you are done.
    Table 10. Action Configuration Properties
    Field Name Property in spm-config.properties Mandat

    ory

    Default Value Description
    SMTP Server Host rta.mail.smtp.host Yes none Used by E-mail alert actions. Specifies the SMTP server host name.
    SMTP Server Port rta.mail.smtp.port No 25 Used by E-mail alert actions. SMTP server port.
    SMTP Server Username rta.mail.smtp.user No none Used by E-mail alert actions. Required only if SMTP server authentication is true. Specifies the SMTP server user name.
    SMTP Server Password rta.mail.smtp.password No   Used by E-mail alert actions. Required only if SMTP server authentication is true. Specifies SMTP server user password.

    You can also enter an encrypted password in this field. To encrypt the password, you can use a password generator tool to obfuscate it. If the password entered in the spm-config.properties file is plain-text, the same appears in the Configuration tab on TIBCO ActiveMatrix Dashboard.

    Authenticate SMTP Server rta.mail.smtp.authentication No false Used by E-mail alert actions. Specifies whether the SMTP server authentication is required or not.
    Email Sender rta.mail.from No Current system user Used by E-mail alert actions. Specifies E-mail From (E-mail Sender)
    Mail Retry Count rta.mail.retry.count No 3 This field is under Advanced Options. Maximum number of times to retry the send email operation. A value of -1 attempts this operation infinitely.
    Mail Retry Interval rta.mail.retry.interval No 2000 This field is under Advanced Options. Time interval, in milliseconds, between retry attempts.
    Log Format rta.log.alert.format No XML The default format of logging actions is XML. As an alternate, you can use the TEXT format.
  4. The following steps show how to handle configuration files:
    1. Starting the Service Performance Manager with a TRA file.
    The Service Performance Manager server uses two different files, one for starting the server JVM and another for application configuration. tibspm.tra is the default file used to start the server JVM. This file provides runtime parameters to start the JVM, such as heap sizes, classpath, etc. It also passes on the application specific configuration to the server using the application_args property. By default, this property points to spm-config.properties in SPM_HOME/config folder. You can use TIBCO Configuration Tool to change the application_args property to a different.TRA file as follows:
    1. In the SPM Start TRA File option, specify the full path of the new TRA file. Remember that the TRA file should first be created externally.
    Note: To start Service Performance Manager with the new TRA file, use tibspm --propFile <new-tra-file>
  5. Changing or overriding the existing server configuration.
    Table 11. Save Options for the Configuration File
    Option Description
    Override the original configuration file Select this option to apply the current configuration to the existing server configuration file, which by default for the first time, is spm-config.properties in SPM_HOME/config folder.
    Save as a new file Select this option to create a new file with the specified name and location.

    In both cases, the chosen TRA file (in Starting the Service Performance Manager with a TRA file.) is modified to use this server configuration by changing its application_args property accordingly.

    TIBCO Configuration Tool also stores these changes such that the defaults values are loaded from the last run.

    Note: The default values are not be loaded from the last run if there is a previous version of TIBCO Configuration Tool installed in this TIBCO_HOME as part of another TIBCO product installation. If so, you must explicitly load the previously stored configuration using the "Load" option and point it to the appropriate sessions files.
  6. Perform the following steps on the summary page:
    1. TIBCO Configuration Tool now shows the location of the folder where the current session state is stored. You can change it as required. Select a location for the Session Scripts and Log Folder.
    2. Ensure that Configure TIBCO Service Performance Manager Arguments is selected. It is selected by default.
    3. Click Configure to configure the server.