Receive over TCP/UDP

You can create a data collector to configure a TCP/UDP socket.

Note

The HOST field is not displayed on the Search tab for data collected over a TCP/UDP connection (by default). However, if the data pattern used for collecting data includes the HOST field, then it is displayed and available for search.

Related topics

Where to find more information

Managing-data-collectors

To configure a TCP/UDP socket as a data collector

  1. Navigate to Administration > Data Collectors > Add Data Collector Plus icon.jpg.
  2. In the Name box, provide a unique name to identify this data collector.
  3. From the Type list, select Receive over TCP/UDP (Syslog etc).

  4. Provide the following information, as appropriate:

    Field

    Description

    Target/Collection Host

    Collection Host (Agent)

    Failed to execute the [excerpt-include] macro. Cause: [Error number 2 in 0: No wiki with id [confluencePage:page] could be found]. Click on this message for details.

    Note: For this type of data collector, the target host and collection host are expected to have different values.

    Collector Inputs

    Protocol

    Select UDP or TCP as appropriate.

    Bind address

    Provide the IP address to which you want to bind for creating a connection.

    Port

    Provide the port to connect to the UDP/TCP protocol.

    Data Pattern

    Pattern

    Select the appropriate data pattern to use for indexing the selected data file.

    For this type of data collector, the product does not support filtering of relevant data patterns. Also, because this data collector receives events asynchronously, you cannot select a data pattern and then preview the way it will appear on the Search tab. Therefore, BMC recommends that you select Free Text in this field, provide other necessary details, and save the data collector. After the data is indexed and starts showing on the Search tab, copy a few lines of the data entries and use them to customize an existing data pattern (by cloning it), or add a new data pattern.

    Date Format

    Manually scan through the list available and select a date format.

    If you do not find a relevant date format, you can also create a new date format by selecting the Create new Date Format option.

    Notes:

    • If you select both – a pattern and a date format, then the date format specified takes precedence over the date format from the pattern that you selected. So the timestamp is indexed as per the specified date format, and the rest of the data is indexed as per the pattern.
    • If you select only a date format, then the date format is used for indexing the timestamp, while the rest of the data is displayed in a raw format in your search results.

    Start/Stop Collection

    (Optional) Select this check box if you want to start the data collection immediately.

    The [expand] macro is a standalone macro and it cannot be used inline. Click on this message for details.

    Tags (optional)
    Inherit Host Level Tags From Target Host
    Select this check box to inherit your tag selections associated with the target host that you selected earlier. This option is not applicable if you did not select a target host.
    Select Tag name
    You can manually add tags by selecting one of the tags in the list, specifying a corresponding value, and clicking Add Plus icon.jpg. The list of added tags is displayed in the Tags pane on the Search tab.
    Click Remove Tag Delete icon.jpgto remove a tag.

    Group Access (optional)

    Inherit Host Level Access Groups From Target Host

    Select this check box to inherit your group access configurations associated with the target host that you selected earlier. This option is not applicable if you did not select a target host.

    Select All Groups

    Select this option if you want to select all user groups. You can also manually select multiple user groups.

    If you do not select any user groups and data access control is not enabled, then by default all users can access data retrieved by this data collector. You can restrict access permissions by selecting the relevant user groups that must be given access permissions. To enable data access control, navigate to Administration > System Settings.

    If you do not select any user group and data access control is enabled, then only the creator of the data collector has access to data retrieved by this data collector.

    For more information, see Managing-user-groups.

  5. Click Create to save your changes.

 

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