IBM Tivoli Monitoring, Version 6.3

Tivoli Data Warehouse environment variables

The Warehouse Proxy agent parameters can be changed in the KHDENV file on Windows systems and the hd.ini file in systems other than Windows systems to customize tracing for the Warehouse Proxy agent. The Summarization and Pruning agent parameters can be changed in the in the KSYENV file on Windows systems and the SY.ini file on non-Windows systems to customize tracing for the Summarization and Pruning Agent.

Table 1. Warehouse proxy environment variables
Variable Purpose
CTIRA_NCSLISTEN The number of RPC threads.
KHD_BATCH_USE Allows inserts to be batched together, reducing the number of transactions against the database, improving performance and reducing network traffic. Default is Y and can be edited by GUI or CLI.
KHD_CNX_POOL_SIZE The total number of preinitialized ODBC connection objects available to the work queue export threads. The default value should match the KHD_EXPORT_THREADS value.
KHD_CNX_WAIT The time in minutes to wait before trying to reconnect. Default is 10 minutes.
KHD_CNX_WAIT_ENABLE A time to wait before a retry. Default is Y. Changing this variable to N does not wait before retries. Setting this variable to N can generate a large log file if the tests to the database fail at each retry. It is advisable not to change this variable.
KHD_EXPORT_THREADS The number of worker threads exporting data to the database. The default value should match the KHD_CNX_POOL_SIZE value.
KHD_QUEUE_LENGTH The length of the KHD work queue. This integer identifies the maximum number of export work requests that can be placed on the work queue before the queue starts rejecting requests. The default value of KHD_QUEUE_LENGTH is 1000. Setting this value to 0 means the queue length has no limit.
KHD_SRV_STATUSTIMEOUT The time in seconds set by default to 600s = 10 minutes. Set KHD_SRV_STATUSTIMEOUT less than KHD_STATUSTIMEOUT by at least 60 seconds. It is advisable not to change this variable.
KHD_WAREHOUSE_TEMS_LIST A space or coma-delimited separated list of monitoring servers. A warehouse proxy agent serves all the agents reporting to those monitoring servers listed. The same monitoring server name must not appear more than once in all the warehouse proxy Tivoli Enterprise Monitoring Server lists in the entire enterprise environment.
KHD_DB_COMPRESSION Used to change the configuration of the Warehouse Proxy Agent to enable or disable database compression.
KHD_WHLOG_ENABLE Used to change the configuration of the Warehouse Proxy Agent to enable or disable data warehouse log tables. This variable is set to N by default.

KHD_SERVER_DIST_
COMPRESSION_
ENABLE

Used to send distributed agent compressed data. This variable is set to Y by default.

KHD_SERVER_Z_
COMPRESSION_
ENABLE

Used to allow z/OS® clients to send compressed data. This variable is set to N by default.

KHD_CLIENT_
COMPRESSION_
ENABLE

Specifies that historical data is not compressed if set to N, which is true even if the Warehouse Proxy Agent server has allowed the compression. This variable does not exist by default.

KHD_DEFAULT_TABLE_
CONTAINER

Name of the database container where tables should be placed.

KHD_DEFAULT_INDEX_
CONTAINER

Name of the database container where indices should be placed.
KHD_PARTITION Controls whether partitioning is enabled (Y) or disabled (N). When disabled, non partitioned tables and indices are created and the old pruning behavior is in effect. When enabled, partitioned tables and indices are created (if supported by the database) and partitions are maintained.
KHD_PARTITIONS_UPWARD Number of partitions to maintain after the current date. This allows for an outage to occur and not cause disruption on the monitoring system, permitting agents to upload their collected historical data. Minimum value of 1, maximum value of 10. Negative values and special characters are not allowed.
Table 2. Summarization and Pruning agent environment variables
Variable Purpose
KSY_BLACKOUT Specifies a comma-separated list of exception times where the Summarization and Pruning agent should not start when using the flexible scheduling. The values in the list should be in the format HH:MM-HH:MM where HH must be between 00 and 23 and MM must be between 00 and 59. The starting time must be smaller than the end time of the exception period. For example, to block the Summarization and Pruning agent from starting between 1 and 2 AM and 5 and 6 PM, use the following time statement: 01:00-01:59,17:00-17:59.
KSY_CNP_SERVER_HOST Tivoli Enterprise Portal Server connection default host.
KSY_CNP_SERVER_PORT Tivoli Enterprise Portal Server connection default port.
KSY_DAY_AGE_UNITS The minimum age of data for daily data in days before aggregation is done.
KSY_EVERY_N_DAYS How often to run the schedule in days (number).
KSY_EVERY_N_MINS Indicates the frequency between Summarization and Pruning agent runs when using the flexible scheduling. Must be a multiple of 15 minutes, with a minimum of 15 and a maximum of 1440 (one day).
KSY_FIXED_SCHEDULE Indicates whether the Summarization and Pruning agent is configured for fixed schedule if set to Y or flexible schedule when set to N.
KSY_HOUR_AGE_UNITS The minimum age of data for hourly data in hours before aggregation is done.
KSY_HOUR_AM_PM Whether to run in the AM or PM (AM/PM).
KSY_HOUR_TO_RUN The hour of the day to run. Valid values are 1-12.
KSY_MAX_ROWS_PER_ TRANSACTION Maximum rows per database transaction.
KSY_MAX_WORKER_THREADS Maximum number of simultaneous worker threads. Default is 1. Recommended value is the number of processors on your server minus 1.
KSY_MINUTE_TO_RUN The minute of the day to run (number).
KSY_SHIFT1_HOURS A comma-separated list of off-peak hour numbers for the shift.
KSY_SHIFT2_HOURS A comma-separated list of peak hour numbers for the shift.
KSY_SHIFTS_ENABLED Shift periods. Only two shifts are allowed. If shifts are enabled, each hour (0-23) must be specified once.
KSY_START_OF_WEEK_DAY Start of the week day, for example: 0 = Sunday 1 = Monday.
KSY_TIMEZONE_IND Time zone indicator. AGENT specifies use the time zone offset of the agent. WAREHOUSE specifies use the time zone offset of the warehouse.
KSY_VACATION_DAYS Vacation days in a comma-separated list of days in YYYYMMDD format.
KSY_VACATIONS_ENABLED Whether vacation is enabled with Y or N.
KSY_WAREHOUSEAGGREGLOG_PRUNE Use to specify the pruning for the WAREHOUSEAGGREGLOG table. The format of the value should be number.unit, where number is the number of units to retain and unit specifies the retention unit, which can be one of day, month or year.
KSY_WAREHOUSELOG_PRUNE Use to specify the pruning for the WAREHOUSELOG table. The format of the value should be number.unit, where number is the number of units to retain and unit specifies the retention unit, which can be one of day, month or year.
KSY_WAREHOUSE_DRIVER The Warehouse Database Connection JDBC Driver.
KSY_WAREHOUSE_PASSWORD The Warehouse Database Connection Password (encrypted).
KSY_WAREHOUSE_URL The Warehouse Database Connection JDBC URL.
KSY_WAREHOUSE_USER The Warehouse Database Connection User (encrypted).
KSY_WEEKENDS_AS_VACATIONS Whether weekends are vacation with Y or N.
KSZ_JAVA_ARGS Java™ arguments.
KSY_WHLOG_ENABLE Used to change the configuration of the Summarization and Pruning Agent to enable or disable data warehouse log tables. The default value is N.
KSY_DB_COMPRESSION Used to change the configuration of the Summarization and Pruning Agent to enable (Y) or disable (N) database compression.
KSY_DEFAULT_TABLE_CONTAINER Name of the database container where tables should be placed.
KSY_DEFAULT_INDEX_CONTAINER Name of the database container where indices should be placed.
KSY_PARTITION Controls whether partitioning is enabled (Y) or disabled (N). When disabled, non partitioned tables and indices are created and the old pruning behavior is in effect. When enabled, partitioned tables and indices are created (if supported by the database) and partitions are maintained.
KSY_PARTITIONS_UPWARD Number of partitions to maintain after the current date. This allows for an outage to occur and not cause disruption on the monitoring system, permitting agents to upload their collected historical data. Minimum value of 1, maximum value of 10. Negative values and special characters are not allowed.
KSY_GROUP_BY_THRESHOLD Number of past days used in the Summarization and Pruning agent discovery query. This is used to improve the Summarization and Pruning agent runtime and to limit the number of partition locks placed on the table.


Feedback