UDP Source

The UDP Source origin reads messages from one or more UDP ports. UDP Source generates a record for every message. UDP Source can read collectd messages, Netflow messages from NetFlow Version 5, and the following types of syslog messages:

When you configure UDP Source, you specify the ports to use and the batch size and wait time.

Configuring a UDP Source

Configure a UDP Source origin to process messages from a UDP source.

  1. In the Properties panel, on the General tab, configure the following properties:
    General Property Description
    Name Stage name.
    Description Optional description.
    On Record Error Error record handling for the stage:
    • Discard - Discards the record.
    • Send to Error - Sends the record to the pipeline for error handling.
    • Stop Pipeline - Stops the pipeline.
  2. On the UDP tab, configure the following properties:
    UDP Property Description
    Port Port to listen to for data. To list additional ports, click the Add icon.
    Note: To listen to a port below 1024, Data Collector must be run by a user with root privileges. Otherwise, the operating system does not allow Data Collector to bind to the port.
    Enable Multithreading On 64-bit Linux, specifies whether to use multiple receiver threads for each port. Using multiple receiver threads can improve performance.

    Because the multithreading requires native libraries, it is only available when Data Collector runs on 64-bit Linux.

    Number of Receiver Threads Number of receiver threads to use for each port. For example, if you configure two threads per port and configure the origin to use three ports, the origin uses a total of six threads.

    Set to the expected number of CPU cores of the Data Collector machine that are dedicated to the Data Collector.

    Default is 1.

    Data Format Data format passed by UDP:
    • collectd
    • NetFlow
    • syslog
    Max Batch Size (messages) Maximum number of messages to include in a batch and pass through the pipeline at one time. Honors values up to the Data Collector maximum batch size.

    Default is 1000. The Data Collector default is 1000.

    Batch Wait Time (ms) Milliseconds to wait before sending a partial or empty batch.
  3. On the syslog tab, define the character set for the data.
  4. On the collectd tab, define the following collectd properties:
    collectd Property Properties
    TypesDB File Path Path to a user-provided types.db file. Overrides the default types.db file.
    Convert Hi-Res Time & Interval Converts the collectd high resolution time format interval and timestamp to UNIX time, in milliseconds.
    Exclude Interval Excludes the interval field from output record.
    Auth File Path to an optional authentication file. Use an authentication file to accept signed and encrypted data.
    Charset Character set of the data.