IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› ›

sflow

edit

sflow

edit

Version: 2.0.0
Released on: 2016-11-02
Changelog
Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-codec-sflow.

The "sflow" codec is for decoding sflow v5 flows.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

sflow {
  }

Available configuration options:

Setting	Input type	Required	Default value
`enable_metric`	boolean	No	`true`
`id`	string	No
`interface_cache_size`	number	No	`1000`
`interface_cache_ttl`	number	No	`3600`
`optional_removed_field`	array	No	["sflow_version", "header_size", "ip_header_length", "ip_dscp", "ip_ecn", "ip_total_length", "ip_identification", "ip_flags", "ip_fragment_offset", "ip_ttl", "ip_checksum", "ip_options", "tcp_seq_number", "tcp_ack_number", "tcp_header_length", "tcp_reserved", "tcp_is_nonce", "tcp_is_cwr", "tcp_is_ecn_echo", "tcp_is_urgent", "tcp_is_ack", "tcp_is_push", "tcp_is_reset", "tcp_is_syn", "tcp_is_fin", "tcp_window_size", "tcp_checksum", "tcp_urgent_pointer", "tcp_options", "vlan_cfi", "sequence_number", "flow_sequence_number", "vlan_type", "udp_length", "udp_checksum"]
`snmp_community`	string	No	`"public"`
`snmp_interface`	boolean	No	`false`
`versions`	array	No	`[5]`

Details

edit

`enable_metric`

edit

Value type is 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`

edit

Value type is string
There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

`interface_cache_size`

edit

Value type is number
Default value is 1000

Specify the max number of element in the interface resolution local cache (only if snmp_interface true)

`interface_cache_ttl`

edit

Value type is number
Default value is 3600

Specify the duration for each element in the interface resolution local cache (only if snmp_interface true)

`optional_removed_field`

edit

Value type is array
Default value is ["sflow_version", "header_size", "ip_header_length", "ip_dscp", "ip_ecn", "ip_total_length", "ip_identification", "ip_flags", "ip_fragment_offset", "ip_ttl", "ip_checksum", "ip_options", "tcp_seq_number", "tcp_ack_number", "tcp_header_length", "tcp_reserved", "tcp_is_nonce", "tcp_is_cwr", "tcp_is_ecn_echo", "tcp_is_urgent", "tcp_is_ack", "tcp_is_push", "tcp_is_reset", "tcp_is_syn", "tcp_is_fin", "tcp_window_size", "tcp_checksum", "tcp_urgent_pointer", "tcp_options", "vlan_cfi", "sequence_number", "flow_sequence_number", "vlan_type", "udp_length", "udp_checksum"]

Specify which sflow fields must not be send in the event

`snmp_community`

edit

Value type is string
Default value is "public"

Specify if codec must perform SNMP call so agent_ip for interface resolution.

`snmp_interface`

edit

Value type is boolean
Default value is false

Specify if codec must perform SNMP call so agent_ip for interface resolution.

`versions`

edit

Value type is array
Default value is [5]

Specify which Sflow versions you will accept.

« s3_plain Contributing to Logstash »