Collect configuration file

The Collect configuration file (Collect.cfg ) is used to define devices, disks, and network interfaces that the collectors do not see by default, or to override various default data collection options. A sample file, Collect.cfg.sample, is located in the following directory:

  • On Windows:   %BEST1_COLLECT_HOME%\bgs\setup
  • On UNIX:   $BEST1_HOME/bgs/setup

You can open the file with a text editor, such as Notepad on Windows or Vi on UNIX.

The file is also used by the UNIX system collector on UNIX and Microsoft Windows platforms. The system configuration options are not currently used by the Windows collectors. Therefore, delete the contents between the BEGIN_SYSTEM_COLLECT and END_SYSTEM_COLLECT if you will be using this file for Windows platforms.

To use the Collect configuration file

  1. Copy the sample file to the following location:
    • On Windows:   %BEST1_COLLECT_HOME%\local\setup
    • On UNIX:   $BEST1_HOME/local/setup
  2. Rename the file from Collect.cfg.sample to Collect.cfg.
  3. Edit the file to conform with your system's configuration and save.

To filter out specific processes

You can filter out specific processes by using the BEGIN_IGNORE_PROCESS option in the Collect.cfg file, where you can define one or more command patterns that you do not want to collect. The command patterns are only compared against the Command metric.

 To filter out specific processes, perform the following task:

  1. Open collect.cfg.
  2. Add the following lines to the file:

    BEGIN_IGNORE_PROCESS
     IGNORE = "ProcessName1"
     END_IGNORE_PROCESS
     BEGIN_IGNORE_PROCESS
     IGNORE ="ProcessName2"
     END_IGNORE_PROCESS
     ... ... and so on.
  3. Save collect.cfg.
  4. Restart the Agent.
    After you restart the agent, you will see that ProcessName1 and ProcessName2 are not present in the process statistics UDR that was collected.

Options for the Collect.cfg file

The following table lists and describes various flags (options) you can set in different sections of the collect.cfg file.

Section

Flag

Description

STORAGE

OVERRIDE_DISKS

Use to override the default data collection configuration for disks. Specify TRUE to suppress the collection of statistics (such as name, model, and size) for disks. The default is FALSE.

OVERRIDE_ CONTROLLERS

Use to override the default data collection configuration for controllers. Specify TRUE to suppress the collection of statistics (such as for name, type, and parent) for disk controllers. The default is FALSE.

DISK

NAME

Use to specify the name of the disk.

MODEL

Use to specify the disk model.

SIZE

Use to specify the maximum storage size of the disk.

IGNORE

Use to override the data collection for disks on a Tru64 UNIX 5.0 computer. Specify TRUE to suppress the collection of disk statistics on this platform. The default is FALSE.

IGNORE_LABEL

Use to override the default data collection configuration for disks on Oracle Solaris computers. Specify TRUE to suppress the collection of the disk model name on this platform. Disk size will be reported as 0. The default is FALSE.

CONTROLLER

NAME

Use to specify the physical name of the hardware circuit that translates disk access instructions from the operating system to the physical disk.

TYPE

Use to specify the type of disk controller. Common disk controller types are IDE and SCSI.

PARENT_NAME

Use to specify the name of the parent device, if applicable. For example, there could be one parent device (Standard PCI IDE Controller or similar) and two child devices (Primary IDE Controller and Secondary IDE Controller).

NETWORK

OVERRIDE_ INTERFACES

Use to override the default data collection for interfaces. Specify TRUE to suppress the collection of the network interface statistics (interface name). The default is FALSE.

INTERFACE

NAME

Use to specify the physical name of the interface card.

TYPE

Use to specify the type of interface card.

PARENT_NAME

Use to specify the name of the parent device, if applicable. For example, there could be one parent device and two child devices.

LOGICAL_ VOLUME

IGNORE_LSM

Use to override the default data collection configuration for logical volume statistics on is collected on Tru64 UNIX computers running Linux Security Modules (LSM). Specify TRUE to suppress data collection for logical volumes on Tru64 UNIX computers running Linux Security Modules (LSM). The default is FALSE.

PROCESS

MEMORY_MAP

On Solaris and Linux systems, the MINIMUM_TIME option defines the frequency of collecting the optional resident set size (RSS) memory metrics (which can be lower than the frequency of collecting process statistics in general). The default is 60 seconds. In earlier versions, this option collected data according to how long the process had been active, and then sampled every 10 seconds. To enable, set ENABLE to TRUE.

MICROSTATE_ ACCOUNTING

Use to enable the collection of Solaris microstate accounting information. This capability is disabled by default. To enable, set ENABLE to TRUE. SAMPLES is the number of samples the collector will attempt to enable microstate accounting for all processes. The default is 3.

OPEN_ DESCRIPTOR

On AIX 5.2 64-bit systems the Perform Collector uses a lot of system time obtaining Process Statistics. This is related to how the Collector obtains the number of open file descriptors. To work around this issue, set the ENABLE flag to FALSE to suppress the collection of open descriptors in the Process Statistics metric group. By default, Perform will continue to collect the number of open file descriptors (ENABLE=TRUE). This option can be used for all platforms.

SCHEDULER_ POLICY

There is a high processor utilization on Solaris 2.8 64-bit systems when there are a large number of processes running. If you are experiencing significant performance issues, you can suppress the collection of the Scheduling Policy Info metric group by setting the BEGIN_SCHEDULER_POLICY option ENABLE flag to FALSE. By default, this flag is set to TRUE. You will see a decrease in CPU utilization when the ENABLE flag is set to FALSE, resulting in a dramatic difference in performance. This option can be used for all platforms.

FILESYSTEM

REMOTE_ FILESYSTEM

Use to override the default data collection configuration for File Systems Statistics. Specify TRUE to enable the data collection of remote file systems. The default is ENABLE=FALSE.

TIMEOUT

Use to override the default data collection configuration time-out value. The default is 10.

IGNORE_TYPE

Use to override the default data collection configuration for specific file types (for example, autofs and nfs3 files). Uncomment the section and specify the filesystem type in the TYPE field.

SYSTEM

MODEL

Use to override the data collection of systems with unknown model types. A system model is unknown if it is not defined in the hardware table.

USER_ID

IGNORE_ SUPPLEMENTAL_ GROUPS

Use to override the default data collection configuration for group IDs. Specify FALSE to enable the reporting of multiple group IDs for all users and only report one group per user. The default is TRUE.

CPU_CONFIG

COLLECTION_ MECHANISM

On Solaris 8 64-bit computers, you might see invalid CPU statistics. This issue is caused by specific Solaris patches (#108528-28 and #108528-29). To work around this issue, set the COLLECTION_MECHANISM flag to kstat. This option causes the Collector to use the kstat API to collect CPU-related statistics, rather than collecting the statistics directly from the kernel. This option can be used for all version of Solaris.

HARDWARE_ PARTITION

HMC_NAME

Specifies the name or the IP address of the HMC that manages the AIX partition.

HMC_USER_NAME

Specifies the user name that the Perform Collector uses to connect to the HMC. The default is hmcviewer.

HMC_MANAGED_ SYSTEM

Specifies the name of the partition for which data is to be collected.

SSH

Specifies the directory where OpenSSH is installed. By default, Gateway Server searches for OpenSSH in the /usr/bin directory. Use this option if you have OpenSSH installed in a different directory in your environment (for example, in /usr/local/bin, or /opt/openssh/bin ).

SYSTEM_COLLECT ARM_COLLECT UMX_COLLECT NT_SYSTEM_ COLLECT


ENABLE_STATUS

Directs the Collector to generate a log file containing an additional level of logging that provides a record of when metric groups are being collected, how many records were collected, the amount of CPU used to collect the records, and the response time for collection. The default setting for all collectors is TRUE.

The log file is located in:

  • On Windows:   %BEST1_COLLECT_HOME%\bgs\log\nodeName-collector-instance-status.log
  • On UNIX:   $BEST1_HOME/bgs/log/nodename-collector-instance-status.log

MAX_MEMORY_USAGE

Specifies the maximum amount of memory that can be used by the Windows or Solaris collector. When enabled, the collector checks its memory usage every 24 hours and if its memory usage exceeds the value defined in this setting, it exits and the agent starts a new collection process. 

For the Windows collector, this setting is enabled by default with a value of 100 MB. For the Solaris collector, it is disabled by default. 

Important: This setting can be used with Solaris only when you apply Cumulative Hotfix 5 or later on Patch 2 (20.02.02) of TrueSight Capacity Optimization 20.02. 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*