--- title: Netflow codec plugin v3.5.2 description: Plugin version: v3.5.2, Released on: 2017-08-15, Changelog. For other versions, see the overview list. To learn more about Logstash, see the Logstash... url: https://www.elastic.co/docs/reference/logstash/versioned-plugins/v3-5-2-plugins-codecs-netflow products: - Logstash applies_to: - Elastic Stack: Generally available --- # Netflow codec plugin v3.5.2 - Plugin version: v3.5.2 - Released on: 2017-08-15 - [Changelog](https://github.com/logstash-plugins/logstash-codec-netflow/blob/v3.5.2/CHANGELOG.md) For other versions, see the [overview list](https://www.elastic.co/docs/reference/logstash/versioned-plugins/codec-netflow-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-codec-netflow). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins). ## Description The "netflow" codec is used for decoding Netflow v5/v9/v10 (IPFIX) flows. ## Supported Netflow/IPFIX exporters This codec supports: - Netflow v5 - Netflow v9 - IPFIX The following Netflow/IPFIX exporters are known to work with the most recent version of the netflow codec: | Netflow exporter | v5 | v9 | IPFIX | Remarks | |--------------------------|-----|-----|-------|---------------------------------------------------------| | Barracuda Firewall | | | y | | | Cisco ASA | | y | | | | Cisco ASR | | y | | | | Cisco IOS 12.x | | y | | | | Cisco WLC | | y | | | | Citrix Netscaler | | | y | Still some unknown fields, labeled netscalerUnknown | | fprobe | y | | | | | Fortigate FortiOS | | y | | | | ipt_NETFLOW | y | y | y | | | Juniper MX80 | y | | | SW > 12.3R8 | | Mikrotik | y | | y | | | nProbe | y | y | y | | | OpenBSD pflow | y | n | y | | | Softflowd | y | y | y | IPFIX supported in | | Streamcore Streamgroomer | | y | | | | Ubiquiti Edgerouter X | | y | | With MPLS labels | | VMware VDS | | | y | Still some unknown fields | ## Usage Example Logstash configuration that will listen on 2055/udp for Netflow v5,v9 and IPFIX: ``` input { udp { port => 2055 codec => netflow } } ``` For high-performance production environments the configuration below will decode up to 6000 flows/sec on an 8 CPU instance. If your total flowrate exceeds 6000 flows/sec, you should use multiple Logstash instances. ``` input { udp { port => 2055 receive_buffer_bytes => 16777216 codec => netflow workers => 6 } ``` Make sure to increase the Linux kernel receive buffer limit: ``` # sysctl -w net.core.rmem_max=$((1024*1024*16)) ``` ## Netflow Codec Configuration Options | Setting | Input type | Required | |-----------------------------------------------------------------------------|-----------------------------------------------------------------|----------| | [`cache_save_path`](#v3.5.2-plugins-codecs-netflow-cache_save_path) | a valid filesystem path | No | | [`cache_ttl`](#v3.5.2-plugins-codecs-netflow-cache_ttl) | [number](/docs/reference/logstash/plugins/value-types#number) | No | | [`include_flowset_id`](#v3.5.2-plugins-codecs-netflow-include_flowset_id) | [boolean](/docs/reference/logstash/plugins/value-types#boolean) | No | | [`ipfix_definitions`](#v3.5.2-plugins-codecs-netflow-ipfix_definitions) | a valid filesystem path | No | | [`netflow_definitions`](#v3.5.2-plugins-codecs-netflow-netflow_definitions) | a valid filesystem path | No | | [`target`](#v3.5.2-plugins-codecs-netflow-target) | [string](/docs/reference/logstash/plugins/value-types#string) | No | | [`versions`](#v3.5.2-plugins-codecs-netflow-versions) | [array](/docs/reference/logstash/plugins/value-types#array) | No | ### `cache_save_path` - Value type is [path](/docs/reference/logstash/plugins/value-types#path) - There is no default value for this setting. Enables the template cache and saves it in the specified directory. This minimizes data loss after Logstash restarts because the codec doesn’t have to wait for the arrival of templates, but instead reload already received templates received during previous runs. Template caches are saved as: - [path](/docs/reference/logstash/plugins/value-types#path)/netflow_templates.cache for Netflow v9 templates. - [path](/docs/reference/logstash/plugins/value-types#path)/ipfix_templates.cache for IPFIX templates. ### `cache_ttl` - Value type is [number](/docs/reference/logstash/plugins/value-types#number) - Default value is `4000` Netflow v9/v10 template cache TTL (seconds) ### `include_flowset_id` - Value type is [boolean](/docs/reference/logstash/plugins/value-types#boolean) - Default value is `false` Only makes sense for ipfix, v9 already includes this Setting to true will include the flowset_id in events Allows you to work with sequences, for instance with the aggregate filter ### `ipfix_definitions` - Value type is [path](/docs/reference/logstash/plugins/value-types#path) - There is no default value for this setting. Override YAML file containing IPFIX field definitions Very similar to the Netflow version except there is a top level Private Enterprise Number (PEN) key added: ``` pen: id: - :uintN or :ip4_addr or :ip6_addr or :mac_addr or :string - :name id: - :skip ``` There is an implicit PEN 0 for the standard fields. See for the base set. ### `netflow_definitions` - Value type is [path](/docs/reference/logstash/plugins/value-types#path) - There is no default value for this setting. Override YAML file containing Netflow field definitions Each Netflow field is defined like so: ``` id: - default length in bytes - :name id: - :uintN or :ip4_addr or :ip6_addr or :mac_addr or :string - :name id: - :skip ``` See for the base set. ### `target` - Value type is [string](/docs/reference/logstash/plugins/value-types#string) - Default value is `"netflow"` Specify into what field you want the Netflow data. ### `versions` - Value type is [array](/docs/reference/logstash/plugins/value-types#array) - Default value is `[5, 9, 10]` Specify which Netflow versions you will accept.