﻿---
title: Udp input plugin v3.5.0
description: Plugin version: v3.5.0, Released on: 2021-08-04, Changelog. For other versions, see the overview list. To learn more about Logstash, see the Logstash...
url: https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/v3-5-0-plugins-inputs-udp
---

# Udp input plugin v3.5.0
- Plugin version: v3.5.0
- Released on: 2021-08-04
- [Changelog](https://github.com/logstash-plugins/logstash-input-udp/blob/v3.5.0/CHANGELOG.md)

For other versions, see the [overview list](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/input-udp-index).
To learn more about Logstash, see the [Logstash Reference](https://www.elastic.co/guide/en/logstash/current/index.html).

## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-input-udp). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

Read messages as events over the network via udp. The only required configuration item is `port`, which specifies the udp port logstash will listen on for event streams.

### Event Metadata and the Elastic Common Schema (ECS)

This plugin adds a field containing the source IP address of the UDP packet. By default, the IP address is stored in the host field. When [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/current) is enabled (in [`ecs_compatibility`](#v3.5.0-plugins-inputs-udp-ecs_compatibility)), the source IP address is stored in the host][ip] field.
You can customize the field name using the [`source_ip_fieldname`](#v3.5.0-plugins-inputs-udp-source_ip_fieldname). See [`ecs_compatibility`](#v3.5.0-plugins-inputs-udp-ecs_compatibility) for more information.

## Udp Input Configuration Options

This plugin supports the following configuration options plus the [Common options](#v3.5.0-plugins-inputs-udp-common-options) described later.

| Setting                                                                                         | Input type                                                                 | Required |
|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|----------|
| [`buffer_size`](#v3.5.0-plugins-inputs-udp-buffer_size)`buffer_size`                            | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number | No       |
| [`ecs_compatibility`](#v3.5.0-plugins-inputs-udp-ecs_compatibility)`ecs_compatibility`          | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string | No       |
| [`host`](#v3.5.0-plugins-inputs-udp-host)`host`                                                 | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string | No       |
| [`port`](#v3.5.0-plugins-inputs-udp-port)`port`                                                 | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number | Yes      |
| [`queue_size`](#v3.5.0-plugins-inputs-udp-queue_size)`queue_size`                               | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number | No       |
| [`receive_buffer_bytes`](#v3.5.0-plugins-inputs-udp-receive_buffer_bytes)`receive_buffer_bytes` | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number | No       |
| [`source_ip_fieldname`](#v3.5.0-plugins-inputs-udp-source_ip_fieldname)`source_ip_fieldname`    | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string | No       |
| [`workers`](#v3.5.0-plugins-inputs-udp-workers)`workers`                                        | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number | No       |

Also see [Common options](#v3.5.0-plugins-inputs-udp-common-options) for a list of options supported by all input plugins.

### `buffer_size`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `65536`

The maximum packet size to read from the network

### `ecs_compatibility`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Supported values are:
  - `disabled`: unstructured connection metadata added at root level
- `v1`: structured connection metadata added under ECS compliant namespaces
- Default value depends on which version of Logstash is running:
  - When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
- Otherwise, the default value is `disabled`.

Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/current).
The value of this setting affects the placement of a TCP connection’s metadata on events.
**Table 2. Metadata Location by `ecs_compatibility` value**

| `disabled` | `v1`               | Availability   | Description                                      |
|------------|--------------------|----------------|--------------------------------------------------|
| host       | host][ip]host][ip] | *Always*Always | *Source IP of UDP packet*Source IP of UDP packet |


### `host`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"0.0.0.0"`

The address which logstash will listen on.

### `port`

- This is a required setting.
- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- There is no default value for this setting.

The port which logstash will listen on. Remember that ports less than 1024 (privileged ports) may require root or elevated privileges to use.

### `queue_size`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `2000`

This is the number of unprocessed UDP packets you can hold in memory before packets will start dropping.

### `receive_buffer_bytes`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- There is no default value for this setting.

The socket receive buffer size in bytes. If option is not set, the operating system default is used. The operating system will use the max allowed value if receive_buffer_bytes is larger than allowed. Consult your operating system documentation if you need to increase this max allowed value.

### `source_ip_fieldname`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value could be `"host"` or `[host][ip]` depending on the value of [`ecs_compatibility`](#v3.5.0-plugins-inputs-udp-ecs_compatibility)

The name of the field where the source IP address will be stored. See [Event Metadata and the Elastic Common Schema (ECS)](#v3.5.0-plugins-inputs-udp-ecs_metadata) for more information on how ECS compatibility settings affect these defaults.
Example:
```
    input {
      udp {
        source_ip_fieldname => "[appliance][monitoring][ip]"
      }
    }
```


### `workers`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `2`

Number of threads processing packets

## Common options

These configuration options are supported by all input plugins:

| Setting                                                                    | Input type                                                                    | Required |
|----------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`add_field`](#v3.5.0-plugins-inputs-udp-add_field)`add_field`             | [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#hash)hash          | No       |
| [`codec`](#v3.5.0-plugins-inputs-udp-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#v3.5.0-plugins-inputs-udp-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#v3.5.0-plugins-inputs-udp-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`tags`](#v3.5.0-plugins-inputs-udp-tags)`tags`                            | [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)array       | No       |
| [`type`](#v3.5.0-plugins-inputs-udp-type)`type`                            | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `add_field`

- Value type is [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#hash)
- Default value is `{}`

Add a field to an event

### `codec`

- Value type is [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)
- Default value is `"plain"`

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

### `enable_metric`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `true`

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

### `id`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 udp inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
```
input {
  udp {
    id => "my_plugin_id"
  }
}
```


### `tags`

- Value type is [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)
- There is no default value for this setting.

Add any number of arbitrary tags to your event.
This can help with processing later.

### `type`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

Add a `type` field to all events handled by this input.
Types are used mainly for filter activation.
The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.
If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.