UDP destination plugin
The UDP destination plugin provides a lightweight and efficient mechanism for transmitting your data, making it ideal for scenarios where low latency and high throughput are critical. Use this plugin to configure your pipeline to send data to a remote UDP endpoint, which lets you integrate your telemetry data with other systems or services.
Configuration parameters
The UDP destination plugin provides these configuration parameters. Items in the Name column display in the web interface. Items in the Key column are the YAML keys to use in pipeline configuration files.
General
| Name | Key | Description | Default |
|---|---|---|---|
| Host | host | Required. IP address or hostname of the target service. | 127.0.0.1 |
| Port | port | Required. TCP port of the target service. | 80 |
| Format | format | Required. Set the format. Accepted values: msgpack, json_lines, json, json_stream. | msgpack |
Advanced
| Name | Key | Description | Default |
|---|---|---|---|
| JSON Date Format | json_date_format | Specify the format of the date. Accepted values: double, epoch, iso8601 (for example, 2018-05-30T09:39:52.000681Z) and java_sql_timestamp (for example, 2018-05-30 09:39:52.000681). | none |
| JSON Date Key | json_date_key | Specify the name of the time key in the output record. To disable the time key, set the value to false. | none |
| Raw Message Key | raw_message_key | Specify the key that contains the message to send in raw format. For example, log key. | none |
Security and TLS
| Name | Key | Description | Default |
|---|---|---|---|
| TLS | tls | Enable or disable TLS/SSL support. Accepted values: true, false. | false |
| TLS Certificate Validation | tls.verify | Turn TLS/SSL certificate validation on or off. TLS must be on for this setting to be enabled. | on |
| TLS Debug Level | tls.debug | Set TLS debug verbosity level. Accepted values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), 4 (Verbose). | 1 |
| CA Certificate File Path | tls.ca_file | Absolute path to CA certificate file. | none |
| Certificate File Path | tls.crt_file | Absolute path to certificate file. | none |
| Private Key File Path | tls.key_file | Absolute path to private key file. | none |
| Private Key Path Password | tls.key_passwd | Optional password for tls.key_file file. | none |
| TLS SNI Hostname Extension | tls.vhost | Hostname to be used for TLS SNI extension. | none |
Advanced Networking
| Name | Key | Description | Default |
|---|---|---|---|
| DNS Mode | net.dns.mode | Select the primary DNS connection type. Accepted values: TCP, UDP. | none |
| DNS Resolver | net.dns.resolver | Select the primary DNS connection type. Accepted values: LEGACY, ASYNC. | none |
| Prefer IPv4 | net.dns.prefer_ipv4 | Prioritize IPv4 DNS results when trying to establish a connection. | false |
| Keepalive | net.keepalive | Enable or disable Keepalive support. | true |
| Keepalive Idle Timeout | net.keepalive_idle_timeout | Set maximum time allowed for an idle Keepalive connection. | 30s |
| Max Connect Timeout | net.connect_timeout | Set the maximum time allowed to establish a connection. This time includes the TLS handshake. | 10s |
| Max Connect Timeout Log Error | net.connect_timeout_log_error | On connection timeout, specify if it should log an error message. When disabled, the timeout is logged as a debug message. | true |
| Source Address | net.source_address | Specify network address to bind for data traffic. | none |
| Max Keepalive Recycle | net.keepalive_max_recycle | Set maximum number of times a keepalive connection can be used before it's retired. | 2000 |