Modifying the configuration files

This topic provides the following information about modifying the product configuration files to customize particular default settings.

Related topics

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:

ComponentDefault locationCustomizable location
Collection Station

\station\collection\conf\agent.properties

\station\collection\custom\
conf\agent.properties

\station\collection\conf\indexstrategies.yml

\station\collection\custom\
conf\customIndexstrategies.yml

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

Note: If you are setting up a search component HA, you must update the Search-specific (searchserviceConfig.properties) properties uniformly across all the search component HA nodes.

\conf\server\searchserviceConfig.properties

\custom\conf\server\
searchserviceCustomConfig.properties

\conf\server\indexstrategies.yml\custom\conf\server\
customIndexstrategies.yml

When you upgrade from TrueSight IT Data Analytics version 11.3.01 to 11.3.02, any changes done in customIndexstrategies.yml file in version 11.3.01 will not be retained after upgrading to version 11.3.02. However, the changes made in version 11.3.01 are there in the backup file created and you can refer to the backup file to modify the new 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

  1. Stop all product services. For more information, see Starting or stopping product services.
  2. 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
  3. 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

  4. 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
  5. Start the 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

You might want to store the configuration database data on a separate disk and perform regular backups to avoid problems related to hardware crashes.

To configure the Configuration Database location path

  1. Stop all product services. For more information, see Starting or stopping product services.
  2. Create a backup of the configdb.conf file by navigating to the following location:
    1. Windows: %BMC_ITDA_HOME%\custom\conf\service
    2. Linux: $BMC_ITDA_HOME/custom/conf/services
  3. 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.
  4. Copy the contents of the ../../data/configdb/ file to the new directory specified in step 3.
  5. Start 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

  1. Navigate to the agent.properties file, as described in the Changing property definitions table.
  2. To change the batch setting, add the collection.thread.pool.size property with the desired value; for example, collection.thread.pool.size=50.
  3. 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.
  4. (Optional) To start all data collectors together (without any time difference) add the property collection.ifmultiple.startup.delay.enabled=false.

Starting or stopping automatically created data collectors

Data collectors are automatically created when event analytics is enabled and TSIM is available in Presentation Server. You can start or stop the automatically created data collectors.

To start or stop the data collectors created automatically

  1. Stop all product services. For more information, see Starting or stopping product services.
  2. In the olaengineCustomConfig.properties file, add the following property
    auto.collector.collection.station
  3. Create a backup of the configdb.conf file by navigating to the following location:
    1. Windows: %BMC_ITDA_HOME%\custom\conf\service
    2. Linux: $BMC_ITDA_HOME/custom/conf/services
  4. Start all the product services. For more information, see Starting or stopping product services.

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

  1. Navigate to %BMC_ITDA_HOME%\custom\conf\server\ on the server where you have installed the Search component.
  2. Edit the olaengineCustomConfig.properties file.
  3. Locate the property, featuretracker.enable.
  4. Change the property value from true to false and save the file.

Enabling data movement from Live node to Archive node

When you configure an Archive node, you must add the following properties to enable the movement of data from the Live nodes to the Archive nodes.

To enable the movement of data

  1. Navigate to %BMC_ITDA_HOME%\custom\conf\server\ on the server where you have installed the Search component.
  2. Edit the searchserviceCustomConfig.properties file.
  3. Add the following properties

    second.level.index.box=archive
    index.movement.feature.enabled=true
    data.movement.indices.after.days=2

  4. Save the file.
  5. Restart the Search component.
  6. Navigate to %BMC_ITDA_HOME%\conf\indexer\ on the server where you have installed the Indexer nodes.
  7. Add the following properties to the elasticsearch.yml file. Ensure that you add the properties in the elasticsearch.yml file of all the Indexer nodes:

    indices.recovery.max_bytes_per_sec: 1024mb
    cluster.routing.allocation.node_concurrent_recoveries: 50

  8. Save the files
  9. Restart the Indexer component.

Ensure that For more information, see  Setting up Archive Indexer nodes

Changing log file properties

To avoid bulky log files, IT Data Analytics uses log rotation, which is an automated process that limits the number and size of log files retained. You can change the maximum number of log files and the size of the following log files for server:

  • Itda.log
  • Itda_metrics.log

To change the maximum number of log files in server

  1. Navigate to %BMC_ITDA_HOME%\conf\server\.

  2. Edit the logback.xml file.
  3. Locate the property maxIndex.
  4. Change the property value to number of log files that you want and save the file.

To change the size of log files in server

  1. Navigate to %BMC_ITDA_HOME%\conf\server\.
  2. Edit the logback.xml file.
  3. Locate the property maxFileSize.
  4. Change the property value to size of log files that you want and save the file.

You can change the maximum number of log files and the size of the following log files for Collection Station:

  • collection.log
  • collection_metrics.log

To change the maximum number of log files in Collection Station 

  1. Navigate to %BMC_ITDA_HOME%\station\collection\conf\.
  2. Edit the logback.xml file.
  3. Locate the property maxIndex.
  4. Change the property value to number of log files that you want and save the file.

To change the size of log files in Collection Station

  1. Navigate to %BMC_ITDA_HOME%\station\collection\conf\.
  2. Edit the logback.xml file.
  3. Locate the property maxFileSize.
  4. Change the property value to size of log files that you want and save the file.



Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Neelam Nilje

    In case of adding search components in HA which properties needs to be changes from mentioned two files? If there any other page having this information in details?

    Regards, Neelam Nilje

    May 08, 2019 07:45
    1. Swati Malhotra

      Hi Neelam,


      If you have multiple search components, you need to ensure that all the properties in the following files are same across all search components.


      • \conf\server\searchserviceConfig.properties
      • \custom\conf\server\searchserviceCustomConfig.properties
      • \conf\server\indexstrategies.yml
      • \custom\conf\server\customIndexstrategies.yml

      Do note that in case of duplicacy, precedence is given to \custom files like \custom\conf\server\searchserviceCustomConfig.properties.

      Please let me know for more information.

      Thanks and regards,

      Swati

      Aug 13, 2019 05:17