Class: LogStash::Codecs::Sflow

Inherits:
Base
  • Object
show all
Defined in:
lib/logstash/codecs/sflow.rb

Overview

The “sflow” codec is for decoding sflow v5 flows.

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Sflow

Returns a new instance of Sflow.



13
14
15
16
17
18
 
# File 'lib/logstash/codecs/sflow.rb', line 13

def initialize(params = {})
  super(params)
  @threadsafe = false
  # noinspection RubyResolve
  @removed_field = %w(record_length record_count record_entreprise record_format sample_entreprise sample_format sample_length sample_count sample_header layer3 layer4 layer4_data header udata) | @optional_removed_field
end

Instance Method Details

#decode(payload) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/logstash/codecs/sflow.rb', line 30

def decode(payload)

  decoded = SFlow.read(payload)

  events = []

  decoded['samples'].each do |sample|
    #Treat case with no flow decoded (Unknown flow)
    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

    #treat sample flow
    if sample['sample_entreprise'] == 0 && sample['sample_format'] == 1
      # Create the logstash event
      event = {
          LogStash::Event::TIMESTAMP => LogStash::Timestamp.now
      }
      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

        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|
          unless k.to_s.eql? 'record_data' or @removed_field.include? k.to_s
            event["#{k}"] = v
          end
        end

        unless record['record_data']['sample_header'].to_s.eql? ''
          record['record_data']['sample_header'].each_pair do |k, v|
            unless k.to_s.eql? 'record_data' or @removed_field.include? k.to_s
              event["#{k}"] = v
            end
          end

          if record['record_data']['sample_header'].has_key?('layer3')
            record['record_data']['sample_header']['layer3']['header'].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']['sample_header']['layer3']['header']['layer4'].each_pair do |k, v|
              unless k.to_s.eql? 'record_data' or @removed_field.include? k.to_s
                event["#{k}"] = v
              end
            end
          end
        end

      end
      events.push(event)

      #treat counter flow
    elsif sample['sample_entreprise'] == 0 && sample['sample_format'] == 2
      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
  end

  events.each do |event|
    yield event
  end
end

#register ⇒ Object 



23
24
25
 
# File 'lib/logstash/codecs/sflow.rb', line 23

def register
  require 'logstash/codecs/sflow/datagram'
end