Maintenance outage for upgrade on Sunday, September 22

This site,, will be inaccessible for two hours starting at 8 AM CDT, Sunday, September 22, for a platform upgrade.

    Page tree
    Skip to end of metadata
    Go to start of metadata

    The Collection Profiles tab allows you to configure data collector templates that can simplify the process of data collection. A collection profile allows administrators to capture the input parameters necessary for creating a data collector and then reuse it for future configurations.

    You can create a collection profile by adding data collector templates by manually providing all the inputs or by using an existing data collector inputs. Once you have created the collection profile, you can associate it with the appropriate host. As soon as you associate the collection profile with the host, in a short period of time, data collectors are automatically added under the Data Collectors tab.

    PATROL for IT Data Analytics
    in one of the following ways:


    Creation of collection profile depends on the number of hosts. You can create one collection profile per host or many collection profiles per host. In a single server environment, where all the components of your application are deployed on the same server, you can create one collection profile with data collector templates for each of the components. After this is done, associate that collection profile with the single host.

    A collection profile has the following advantages:

    • Reduces the amount of manual work and time for configuring data collectors.
    • Reduces errors introduced during manual configuration.
    • Ensures consistent collection configuration across respective environments.
    • Helps automate the configuration of hosts and allows it to be driven from TrueSight Infrastructure Management (by using 
      PATROL for IT Data Analytics
      for the configuration).

    Use case for using a collection profile

    Collection profiles can be useful in a scenario where you have multitier applications existing on multiple hosts. The following use case describes such a scenario:


    Base Scenario: Suppose you are an administrator responsible for collecting data. In this role, you will first identify the various hosts in your environment from which you want to collect data. Suppose that in your environment, you have two applications with two tiers and each tier lies on a different host.

    Environment: Application A is made up of Apache Tomcat with an Oracle database on the back end (that resides on a separate host). Application B is made up of Apache Tomcat with a Microsoft SQL Server on the back end (that resides on a separate host). While Application A runs on both Windows and Linux, Application B runs on Windows only. Oracle runs on Linux, while Microsoft SQL Server runs on Windows. Multiple instances of Applications A and B are spread across multiple hosts.

    Usage: As an administrator, you can proceed as follows:

    1. Identify the common profiles that exist across the various hosts supporting the two applications:
      • Oracle database log files on Linux
      • Microsoft SQL Server database log files on Windows
      • Apache Tomcat generic log files on Windows and Linux
      • Application-specific log files for Application A on Windows and Linux
      • Application-specific log files for Application B on Linux
    2. Identify the log file paths for each of the profiles identified in step 1. Navigate to Administration > Collection Profiles and configure a collection profile for a specific host, adding separate data collector templates for each of the profiles. While adding a data collector template, you can specify the input parameters required for the data collection, the tags, and the group access permissions that will be passed on to the data collector.
    3. Navigate to Administration > Hosts, and associate the collection profile with each of the hosts relevant to the various profiles.
    4. Within a short period of time, the data collectors for each of the profiles are automatically created and data collection starts.

    Using macros while adding data collector templates

    Macros can be defined as objects that store values that can be referred by the data collector templates at the time of creating data collectors. At the time of adding data collector templates, you can specify macro names instead of manually providing input parameters. When the data collectors are created on the basis of the data collector templates, the macro values are substituted for the fields in which you specified macro names. To be able to specify macros while adding data collector templates, you need to first add them under the Macros section by providing a macro name and a corresponding macro value.

    Using macros helps you define common input parameters (such as directory path, file name, tag values, and so on) at one time and then reuse that information each time you want to create a data collector template. It is also useful if you want to modify the values of common input parameters together without having to edit each data collector template and manually modify values.

    Additionally, you can override macro values in the following ways:

    • At the time of configuring Collection Agents by using
      PATROL for IT Data Analytics
    • At the time of adding hosts.
      While adding hosts, the macro value changes are not applied to the original collection profile instances. The new values are only used for creating data collectors at run time.


    While specifying macro names as input parameters, you need to specify the macro name in the format, ${MacroName}.

    The MacroName refers to the macro name displayed in the list of added macros.

    The following table lists the fields for which the macros are supported and the associated data collectors where you need to provide these field inputs:

    Supported fieldsData collectors applicable
    • Directory Path
    • Filename/Rollover pattern
    • Monitor file over Windows share
    • Monitor file on Collection Agent
    • Instance Name
    • Tag values
    • Monitor file over Windows share
    • Monitor file on Collection Agent
    • Receive over TCP/UDP
    • Monitor local Windows events
    • Monitor remote Windows events
    • Bind Address
    • Port
    • Receive over TCP/UDP
    • Receive over HTTP/HTTPS

    Host Key Fingerprint

    • Monitor file over SSH
    • Monitor script output over SSH

    Keystore Path

    Receive over HTTP/HTTPS

    While adding macros, the following conditions apply:

    • Macro name or value length cannot be more than 255 characters.
    • Macro name cannot contain the closing curly bracket (}).
    • Macro name or value cannot be empty.

    Icons and associated functions on Collection Profiles tab

    The Collection Profiles tab allows you to manage collection profiles. To access this tab, navigate to Administration > Collection Profiles. From here, you can perform the following actions:

    Add Collection Profile 

    Add a new collection profile.

    For more information, see 799097055.

    View Collection Profile

    View details of the selected collection profile.

    Edit Collection Profile

    Modify details of the selected collection profile.

    You can modify the same details that you provided while adding a collection profile.

    Note: You cannot modify a collection profile that was imported via a content pack. However, you can clone that collection profile and customize it as per your needs.

    Delete Collection ProfileDelete the selected collection profile.
    Clone Collection ProfileMake a copy of the selected collection profile.

    In the search bar, at the top-right side of your screen, you can filter collection profiles in the following ways:

    • Name
    • Content pack name
    • Description

    The Collection Profiles tab provides the following information:

    NameName of the collection profile configured.
    Content Pack

    Name of the content pack via which the collection profile was imported.

    If the collection profile was newly created, then this column displays a hyphen (-).

    DescriptionDescription of the collection profile configured.

    Creating a collection profile

    1. Navigate to Administration > Collection Profiles.
    2. Click Add Collection Profile
    3. In the Name field, provide an appropriate name to identify the collection profile.
    4. (Optional) In the Description field, provide additional information about the collection profile.
    5. (Optional)Create macros by performing the following steps:
      1. Click the Macros section to expand it.
      2. Provide the macro name and corresponding value for the supported fields in the data collector templates.
        For more information about adding macros, see 799097055.
      3. Click Add Macro to save the changes and display it in a list of added macros.
        You can optionally delete the macros added, by clicking Remove Macro next to the macros that you want to delete.
    6. Click Create Data Collector Template to add data collector templates in one of the following ways:


      BMC recommends that you use option 1 for creating the data collector templates if you do not know the specific data pattern necessary for the data that you want to collect. If you create a data collector first, then you can easily find the relevant data pattern by using the filter and preview options available. You can then use the inputs of this data collector for creating the data collector templates.

      1Search for an existing data collector and use its input parameters for creating a new data collector template.
      1. On the search bar, search for an existing data collector by entering its name.
      2. Select one of the appropriate names displayed in the search suggestions
        The input parameters are automatically populated.
      3. Click Create.
      2Create a new data collector template by manually providing the input parameters.
      1. Instance Name: Provide an appropriate name to identify the data collector template.
      2. Type: Select one of the following options, provide the necessary collector inputs, and click Create:

      Note: This note is only applicable if you are creating a data collector template to collect Windows events. While creating the data collector template, the Windows Event Log(s) field only displays the Application, Security, and System options. You cannot retrieve a list of all the application logs configured on the Collection Host (where the Collection Station or Collection Agent is located). However, you can manually enter the exact name of the Windows log that you want to collect and press Enter to add the specified log name.

    7. Click Create.

    Where to go from here

    Associate the collection profile with the appropriate hosts. For more information, see Setting up host profiles for target computers.