logstash-codec-sflow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7734945c0489502693b7f17044c6f96bae64637b
+  data.tar.gz: 9b353b730c693c2397f5edb013c3b0811a5f133c
+SHA512:
+  metadata.gz: 5767825ecfb36ad9a4738cf770fb0718f9a785264b7e87fabbf6e292afaa058ff49fa6761cc5e456ffbcec4f4875cc7cfd48a19597d74a8fb0ac0d3f133fada6
+  data.tar.gz: 90e4aa370af0b55f121aa7b922e577d6153b166724048fdb3eaee630366214360b8dc0d3088a01d56a6d1ed8e98fb2475fc0036f1acbb4bc27faeeb918cfd4b0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-codec-example
+Example codec plugin. This should help bootstrap your effort to write your own codec plugin!

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,100 @@
+# Logstash Codec SFlow Plugin
+## Description
+Logstash codec plugin to decrypt sflow
+
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Codecs/job/logstash-plugin-codec-example-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Codecs/job/logstash-plugin-codec-example-unit/)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/codecs/sflow/counter_record.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+require 'bindata'
+
+class GenericInterface < BinData::Record
+  endian :big
+  uint32 :interface_index
+  uint32 :interface_type
+  uint64 :interface_speed
+  uint32 :interface_direction
+  uint32 :interface_status
+  uint64 :input_octets
+  uint32 :input_packets
+  uint32 :input_multicast_packets
+  uint32 :input_broadcast_packets
+  uint32 :input_discarded_packets
+  uint32 :input_errors
+  uint32 :input_unknown_protocol_packets
+  uint64 :output_octets
+  uint32 :output_packets
+  uint32 :output_multicast_packets
+  uint32 :output_broadcast_packets
+  uint32 :output_discarded_packets
+  uint32 :output_errors
+  uint32 :promiscous_mode
+end
+
+class EthernetInterfaces < BinData::Record
+  endian :big
+  uint32 :dot3StatsAlignmentErrors
+  uint32 :dot3StatsFCSErrors
+  uint32 :dot3StatsSingleCollisionFrames
+  uint32 :dot3StatsMultipleCollisionFrames
+  uint32 :dot3StatsSQETestErrors
+  uint32 :dot3StatsDeferredTransmissions
+  uint32 :dot3StatsLateCollisions
+  uint32 :dot3StatsExcessiveCollisions
+  uint32 :dot3StatsInternalMacTransmitErrors
+  uint32 :dot3StatsCarrierSenseErrors
+  uint32 :dot3StatsFrameTooLongs
+  uint32 :dot3StatsInternalMacReceiveErrors
+  uint32 :dot3StatsSymbolErrors
+end
+
+class TokenRing < BinData::Record
+  endian :big
+  uint32 :dot5StatsLineErrors
+  uint32 :dot5StatsBurstErrors
+  uint32 :dot5StatsACErrors
+  uint32 :dot5StatsAbortTransErrors
+  uint32 :dot5StatsInternalErrors
+  uint32 :dot5StatsLostFrameErrors
+  uint32 :dot5StatsReceiveCongestions
+  uint32 :dot5StatsFrameCopiedErrors
+  uint32 :dot5StatsTokenErrors
+  uint32 :dot5StatsSoftErrors
+  uint32 :dot5StatsHardErrors
+  uint32 :dot5StatsSignalLoss
+  uint32 :dot5StatsTransmitBeacons
+  uint32 :dot5StatsRecoverys
+  uint32 :dot5StatsLobeWires
+  uint32 :dot5StatsRemoves
+  uint32 :dot5StatsSingles
+  uint32 :dot5StatsFreqErrors
+end
+
+class HundredBaseVG < BinData::Record
+  endian :big
+  uint32 :dot12InHighPriorityFrames
+  uint64 :dot12InHighPriorityOctets
+  uint32 :dot12InNormPriorityFrames
+  uint64 :dot12InNormPriorityOctets
+  uint32 :dot12InIPMErrors
+  uint32 :dot12InOversizeFrameErrors
+  uint32 :dot12InDataErrors
+  uint32 :dot12InNullAddressedFrames
+  uint32 :dot12OutHighPriorityFrames
+  uint64 :dot12OutHighPriorityOctets
+  uint32 :dot12TransitionIntoTrainings
+  uint64 :dot12HCInHighPriorityOctets
+  uint64 :dot12HCInNormPriorityOctets
+  uint64 :dot12HCOutHighPriorityOctets
+end
+
+class Vlan < BinData::Record
+  endian :big
+  uint32 :vlan_id
+  uint64 :octets
+  uint32 :ucastPkts
+  uint32 :multicastPkts
+  uint32 :broadcastPkts
+  uint32 :discards
+end
+
+
+class ProcessorInformation < BinData::Record
+  endian :big
+  uint32 :five_sec_cpu_percent
+  uint32 :one_min_cpu_percent
+  uint32 :five_min_cpu_percent
+  uint64 :total_memory
+  uint64 :free_memory
+end
+
+class HttpCounters < BinData::Record
+  endian :big
+  uint32 :method_option_count
+  uint32 :method_get_count
+  uint32 :method_head_count
+  uint32 :method_post_count
+  uint32 :method_put_count
+  uint32 :method_delete_count
+  uint32 :method_trace_count
+  uint32 :method_connect_count
+  uint32 :method_other_count
+  uint32 :status_1XX_count
+  uint32 :status_2XX_count
+  uint32 :status_3XX_count
+  uint32 :status_4XX_count
+  uint32 :status_5XX_count
+  uint32 :status_other_count
+end

data/lib/logstash/codecs/sflow/datagram.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'bindata'
+require 'logstash/codecs/sflow/util'
+require 'logstash/codecs/sflow/sample'
+
+class SFlow < BinData::Record
+  endian :big
+  uint32 :sflow_version
+  uint32 :ip_version
+  choice :agent_ip, :selection => :ip_version do
+    ip4_addr 1
+    ip6_addr 2
+  end
+  uint32 :sub_agent_id
+  uint32 :sequence_number
+  uint32 :uptime_in_ms
+  uint32 :sample_count
+  array :samples, :initial_length => :sample_count do
+    bit20 :sample_entreprise
+    bit12 :sample_format
+    uint32 :sample_length
+    choice :sample_data, :selection => lambda { "#{sample_entreprise}-#{sample_format}" } do
+      flow_sample "0-1"
+      counter_sample "0-2"
+      skip :default, :length => :sample_length
+    end
+  end
+end

data/lib/logstash/codecs/sflow/flow_record.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'bindata'
+require 'logstash/codecs/sflow/util'
+
+class RawPacketHeader < BinData::Record
+  endian :big
+  uint32 :protocol
+  uint32 :frame_length
+  uint32 :stripped
+  uint32 :header_size
+  skip :length => :header_size
+end
+
+class EthernetFrameData < BinData::Record
+  endian :big
+  uint32 :packet_length
+  mac_address :src_mac
+  mac_address :dst_mac
+  uint32 :type
+end
+
+class IP4Data < BinData::Record
+  endian :big
+  uint32 :ip_packet_length
+  uint32 :ip_protocol
+  ip4_addr :src_ip
+  ip4_addr :dst_ip
+  uint32 :src_port
+  uint32 :dst_port
+  uint32 :tcp_flags
+  uint32 :type
+end
+
+class IP6Data < BinData::Record
+  endian :big
+  uint32 :ip_packet_length
+  uint32 :ip_next_header
+  ip6_addr :src_ip
+  ip6_addr :dst_ip
+  uint32 :src_port
+  uint32 :dst_port
+  uint32 :tcp_flags
+  uint32 :ip_priority
+end
+
+class ExtendedSwitchData < BinData::Record
+  endian :big
+  uint32 :src_vlan
+  uint32 :src_priority
+  uint32 :dst_vlan
+  uint32 :dst_priority
+end
+
+class ExtendedRouterData < BinData::Record
+  endian :big
+  uint32 :ip_version
+  choice :ip_address_next_hop_router, :selection => :ip_version do
+    ip4_addr 1
+    ip6_addr 2
+  end
+  uint32 :src_mask_len
+  uint32 :dst_mask_len
+end

data/lib/logstash/codecs/sflow/sample.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'bindata'
+require 'logstash/codecs/sflow/flow_record'
+require 'logstash/codecs/sflow/counter_record'
+
+class FlowSample < BinData::Record
+  endian :big
+  uint32 :sequence_number
+  uint8 :source_id_type
+  uint24 :source_id_index
+  uint32 :sampling_rate
+  uint32 :sample_pool
+  uint32 :drops
+  uint32 :input_interface
+  uint32 :output_interface
+  uint32 :record_count
+  array :records, :initial_length => :record_count do
+    bit20 :record_entreprise
+    bit12 :record_format
+    uint32 :record_length
+    choice :record_data, :selection => :record_format do
+      raw_packet_header 1
+      ethernet_frame_data 2
+      ip4_data 3
+      ip6_data 4
+      extended_switch_data 1001
+      extended_router_data 1002
+      skip :default, :length => :record_length
+    end
+  end
+end
+
+class CounterSample < BinData::Record
+  endian :big
+  uint32 :sample_seq_number
+  uint8 :source_id_type
+  uint24 :source_id_index
+  uint32 :record_count
+  array :records, :initial_length => :record_count do
+    bit20 :record_entreprise
+    bit12 :record_format
+    uint32 :record_length
+    choice :record_data, :selection => lambda { "#{record_entreprise}-#{record_format}" } do
+      generic_interface "0-1"
+      ethernet_interfaces "0-2"
+      token_ring "0-3"
+      hundred_base_vg "0-4"
+      vlan "0-5"
+      processor_information "0-1001"
+      http_counters "0-2201"
+      skip :default, :length => :record_length
+    end
+    #processor_information :record_data
+  end
+end

data/lib/logstash/codecs/sflow/util.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'bindata'
+require 'ipaddr'
+
+class MacAddress < BinData::Primitive
+  array :bytes, :type => :uint8, :initial_length => 6
+  bit16 :padbytes
+
+  def set(val)
+    ints = val.split(/:/).collect { |int| int.to_i(16) }
+    self.bytes = ints
+  end
+
+  def get
+    self.bytes.collect { |byte| byte.value.to_s(16).rjust(2, '0') }.join(":")
+  end
+end
+
+class IP4Addr < BinData::Primitive
+  endian :big
+  uint32 :storage
+
+  def set(val)
+    ip = IPAddr.new(val)
+    if !ip.ipv4?
+      raise ArgumentError, "invalid IPv4 address '#{val}'"
+    end
+    self.storage = ip.to_i
+  end
+
+  def get
+    IPAddr.new_ntoh([self.storage].pack('N')).to_s
+  end
+end
+
+class IP6Addr < BinData::Primitive
+  endian :big
+  uint128 :storage
+
+  def set(val)
+    ip = IPAddr.new(val)
+    if !ip.ipv6?
+      raise ArgumentError, "invalid IPv6 address `#{val}'"
+    end
+    self.storage = ip.to_i
+  end
+
+  def get
+    IPAddr.new_ntoh((0..7).map { |i|
+      (self.storage >> (112 - 16 * i)) & 0xffff
+    }.pack('n8')).to_s
+  end
+end

data/lib/logstash/codecs/sflow.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require "logstash/codecs/base"
+require "logstash/namespace"
+
+# The "sflow" codec is for decoding sflow v5 flows.
+class LogStash::Codecs::Sflow < LogStash::Codecs::Base
+  config_name "sflow"
+
+  # Specify which sflow must not be send in the event
+  config :removed_field, :validate => :array, :default => ['record_length', 'record_count', 'record_entreprise',
+                                                           'record_format', 'sample_entreprise', 'sample_format',
+                                                           'sample_length', 'sample_count', 'sflow_version',
+                                                           'ip_version']
+
+
+  def initialize(params = {})
+    super(params)
+    @threadsafe = false
+  end
+
+  # def initialize
+
+  public
+  def register
+    require "logstash/codecs/sflow/datagram"
+  end
+
+  # def register
+
+  public
+  def decode(payload)
+    decoded = SFlow.read(payload)
+
+    events = []
+
+    decoded['samples'].each do |sample|
+      if sample['sample_data'].to_s.eql? ''
+        @logger.warn("Unknown sample entreprise #{sample['sample_entreprise'].to_s} - format #{sample['sample_format'].to_s}")
+        next
+      end
+      sample['sample_data']['records'].each do |record|
+        # Ensure that some data exist for the record
+        if record['record_data'].to_s.eql? ''
+          @logger.warn("Unknown record entreprise #{record['record_entreprise'].to_s}, format #{record['record_format'].to_s}")
+          next
+        end
+
+        # Create the logstash event
+        event = {
+            LogStash::Event::TIMESTAMP => LogStash::Timestamp.now
+        }
+
+        decoded.each_pair do |k, v|
+          unless k.to_s.eql? 'samples' or @removed_field.include? k.to_s
+            event["#{k}"] = v
+          end
+        end
+
+        sample.each_pair do |k, v|
+          unless k.to_s.eql? 'sample_data' or @removed_field.include? k.to_s
+            event["#{k}"] = v
+          end
+        end
+
+        sample['sample_data'].each_pair do |k, v|
+          unless k.to_s.eql? 'records' or @removed_field.include? k.to_s
+            event["#{k}"] = v
+          end
+        end
+
+        record.each_pair do |k, v|
+          unless k.to_s.eql? 'record_data' or @removed_field.include? k.to_s
+            event["#{k}"] = v
+          end
+        end
+
+        record['record_data'].each_pair do |k, v|
+          event["#{k}"] = v
+        end
+
+        events.push(event)
+      end
+    end
+
+    events.each do |event|
+      yield event
+    end
+  end # def decode
+end # class LogStash::Filters::Sflow

data/logstash-codec-sflow.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+
+  s.name = 'logstash-codec-sflow'
+  s.version = '0.1.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "The sflow codec is for decoding SFlow v5 flows."
+  s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors = ["Nicolas Fraison"]
+  s.email = ''
+  s.homepage = ""
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*', 'spec/**/*', 'vendor/**/*', '*.gemspec', '*.md', 'CONTRIBUTORS', 'Gemfile', 'LICENSE', 'NOTICE.TXT']
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = {"logstash_plugin" => "true", "logstash_group" => "codec"}
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 1.4.0", "< 3.0.0"
+  s.add_runtime_dependency 'bindata', ['>= 2.1.0']
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/codecs/sflow_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/sflow"
+
+describe LogStash::Codecs::Sflow do
+  before :each do
+    @subject = LogStash::Codecs::Sflow.new
+    payload = IO.read(File.join(File.dirname(__FILE__), "sflow_counters_sample.dat"), :mode => "rb")
+    @subject.decode(payload)
+    payload = IO.read(File.join(File.dirname(__FILE__), "sflow_flow_sample.dat"), :mode => "rb")
+    @subject.decode(payload)
+  end
+
+  describe "#new" do
+    it "LogStash::Codecs::Sflow" do
+      @subject.should be_an_instance_of LogStash::Codecs::Sflow
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-sflow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Fraison
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  name: bindata
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/codecs/sflow.rb
+- lib/logstash/codecs/sflow/counter_record.rb
+- lib/logstash/codecs/sflow/datagram.rb
+- lib/logstash/codecs/sflow/flow_record.rb
+- lib/logstash/codecs/sflow/sample.rb
+- lib/logstash/codecs/sflow/util.rb
+- logstash-codec-sflow.gemspec
+- spec/codecs/sflow_counters_sample.dat
+- spec/codecs/sflow_flow_sample.dat
+- spec/codecs/sflow_spec.rb
+homepage: ''
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: codec
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: The sflow codec is for decoding SFlow v5 flows.
+test_files:
+- spec/codecs/sflow_counters_sample.dat
+- spec/codecs/sflow_flow_sample.dat
+- spec/codecs/sflow_spec.rb