Modifying the configuration files
This topic provides the following information about modifying the product configuration files to customize particular default settings.
Changing property definitions
The product's configuration information, including the default and customizable settings, are stored in the configuration files. These files come packaged with the product installation and usually end with the .properties extension, .yml extension, or .conf extension:
- The .properties file stores information for various aspects of the product configuration, including data collection, product user-interface settings, Search settings, and Indexer settings.
- The product stores the collected data in time-based indices. The size of each of the indices is defined by the properties in the .yml file.
- The .conf files store the initial and maximum memory settings for various components. For more information, see Component configuration recommendations for horizontal scaling.
Note
Any change that you make in the customIndexstrategies.yml file must be reflected in both locations (the Collection Station and the Search), as described in the following table.
You can navigate to the appropriate custom folder and edit the appropriate file to modify existing properties or add new properties related to one of the product aspects that you want to change. While modifying a property, ensure that the property is uncommented. The properties that you modify in the custom folder take precedence over those stored by default in the conf folders.
Warning
To avoid future problems, do not modify the default property definitions.
The location paths provided in the following table (except the Collection Agent) must be preceded by the following environment variable, as appropriate:
- Windows: %BMC_ITDA_HOME%
- Linux: $BMC_ITDA_HOME
The Collection Agent location path must be preceded by the following environment variable, as appropriate:
- Windows: %PATROL_HOME%
- Linux: $PATROL_HOME
Navigate to the following customizable locations, as applicable, to change the default values of the properties available:
Component | Default location | Customizable location |
---|---|---|
Collection Station | \station\collection\conf\agent.properties | \station\collection\custom\ |
\station\collection\conf\indexstrategies.yml | \station\collection\custom\ | |
Collection Agent (standalone) | \agent\collection\conf\agent.properties | \agent\collection\custom\ conf\agent.properties |
Collection Agent (for PATROL infrastructure) | \bww\udc\conf\agent.properties | \bww\udc\conf\agent.properties |
Console Server | \conf\server\ olaengineConfig.properties | \custom\conf\server\ olaengineCustomConfig.properties |
Search | \conf\server\searchserviceConfig.properties | \custom\conf\server\ |
\conf\server\indexstrategies.yml | \custom\conf\server\ customIndexstrategies.yml |
Changing directory location for indexed data
By default, the data collected and indexed is stored at the following location:
- Windows: %BMC_ITDA_HOME%\data\indexer
- Linux: $BMC_ITDA_HOME/data/indexer
Tip
In a few scenarios, you might want to change the directory location for the indexed data; for example:
- If you want to store the Indexer data on a separate disk to enable data back-ups or track the data size
- If you want to distribute the disk I/O between the operating system of your computer and the product data collection+search mechanism.
Note
If you change the default directory location of the Indexer, then after uninstalling the product, you must manually delete the new directory.
To configure the Indexer location path
- Stop all product services. For more information, see Starting or stopping product services.
- Create a backup of the indexer.conf file by navigating to the following location:
- Windows: %BMC_ITDA_HOME%\custom\conf\services
- Linux: $BMC_ITDA_HOME/custom/conf/services
- In the indexer.conf file, locate the following line, change the value to the desired data location path, and save the file:
wrapper.java.additional.10=-Des.path.data="%BMC_ITDA_HOME%"/data/indexer
- Copy the BMCINDEXERCLUSTER directory along with all of its sub-directories and files, at the following location to the location specified in step 3:
- Windows: %BMC_ITDA_HOME%\data\indexer
- Linux: $BMC_ITDA_HOME/data/indexer
- Restart all product services. For more information, see Starting or stopping product services.
Changing directory location for the Configuration Database data
By default, the Configuration Database data is stored at the following location:
- Windows: %BMC_ITDA_HOME%\data\configdb
- Linux: $BMC_ITDA_HOME/data/configdb
Tip
To configure the Configuration Database location path
- Stop all product services. For more information, see Starting or stopping product services.
- Create a backup of the configdb.conf file by navigating to the following location:
- Windows: %BMC_ITDA_HOME%\custom\conf\service
- Linux: $BMC_ITDA_HOME/custom/conf/services
In the configdb.conf file, locate the following line, change the value to the desired location path, and save the file:
wrapper.app.parameter.7=file:../../data/configdb/ITDADB
Note
In the preceding property value:
- ../../data/configdb/ refers to the directory location of the database files that you need to change.
- ITDADB refers to the prefix of the database files that must not be changed.
- Copy the contents of the ../../data/configdb/ file to the new directory specified in step 3.
- Restart all the product services. For more information, see Starting or stopping product services.
Changing the polling batch and time setting for data collectors
When you start the product, by default a batch of 10 data collectors are polled for starting. By default, every next batch of 10 data collectors are polled after a time difference of 1 second. This is helpful when you have a large number of data collectors in your environment. BMC recommends you to use the following table as a guide to decide when you want to increase the collection thread pool size. This table provides information about data collectors with one minute polling interval. If the scheduled polling falls behind the one minute interval, then you need to increase the collection thread pool size.
collection.thread.pool.size | Number of data collectors |
---|---|
10 | 375 |
20 | 750 |
30 | 1125 |
40 | 1500 |
To change the batch and time setting
- Navigate to the agent.properties file, as described in the Changing property definitions table.
- To change the batch setting, add the
collection.thread.pool.size
property with the desired value; for example,collection.thread.pool.size=50
. - To change the time setting, add the
collection.ifmultiple.startup.delay
property with the desired value (in seconds); for example,collection.ifmultiple.startup.delay=5
. - (Optional) To start all data collectors together (without any time difference) add the property
collection.ifmultiple.startup.delay.enabled=false
.
Disabling the collection of product usage information
While installing or upgrading the product, if the Allow BMC to collect product usage information check box is selected, collection of the product usage information is enabled. If you later decide that you do not want BMC to collect the product usage information, you can disable the collection.
To disable the collection of product usage information
- Navigate to %BMC_ITDA_HOME%\custom\conf\server\olaengineCustomConfig.properties.
- Edit the olaengineCustomConfig.properties file.
- Locate the property,
featuretracker.enable
. - Change the property value from
true
tofalse
and save the file.
Comments
Log in or register to comment.