Class: LogStash::Filters::KafkaTimeMachine

Inherits:
Base
  • Object
show all
Defined in:
lib/logstash/filters/kafka_time_machine.rb

Instance Method Summary collapse

Instance Method Details

#create_point_ktm(datacenter, event_owner, payload_size_bytes, lag_type, lag_ms, epoch_time_ns, elasticsearch_cluster, elasticsearch_cluster_index) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/logstash/filters/kafka_time_machine.rb', line 190

def create_point_ktm(datacenter, event_owner, payload_size_bytes, lag_type, lag_ms, epoch_time_ns, elasticsearch_cluster, elasticsearch_cluster_index)

  point = Hash.new

  # Name of point and time created
  point["name"]           = "ktm"
  point["epoch_time_ns"] = epoch_time_ns

  # tags
  point["datacenter"]       = datacenter
  point["owner"]            = event_owner
  point["lag_type"]         = lag_type
  point["es_cluster"]       = elasticsearch_cluster
  point["es_cluster_index"] = elasticsearch_cluster_index

  # fields
  point["payload_size_bytes"] = payload_size_bytes
  point["lag_ms"]             = lag_ms

  return point

end

#create_point_ktm_error(datacenter, event_owner, epoch_time_ns, type, elasticsearch_cluster, elasticsearch_cluster_index) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/logstash/filters/kafka_time_machine.rb', line 215

def create_point_ktm_error(datacenter, event_owner, epoch_time_ns, type, elasticsearch_cluster, elasticsearch_cluster_index)

  # Check for nil values
  if (nil == datacenter)
    datacenter = "unknown"
  end

  if (nil == event_owner)
    event_owner = "unknown"
  end

  # set time if we didn't recieve it
  if (nil == epoch_time_ns)
    epoch_time_ns = ((Time.now.to_f * 1000).to_i)*1000000
  end

  point = Hash.new

  # Name of point and time created
  point["name"]           = "ktm_error"
  point["epoch_time_ns"] = epoch_time_ns

  # tags
  point["datacenter"]       = datacenter
  point["owner"]            = event_owner
  point["source"]           = type
  point["es_cluster"]       = elasticsearch_cluster
  point["es_cluster_index"] = elasticsearch_cluster_index

  # fields
  point["count"] = 1

  return point

end

#filter(event) ⇒ Object 



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/logstash/filters/kafka_time_machine.rb', line 56

def filter(event)

  @logger.debug("Starting filter calculations")

  # Note - It was considered to error check for strings that are invalid, i.e. "%{[@metadata][ktm][kafka_datacenter_shipper]}".  However, this string being present is a good way to identify
  # shipper/indexer logstash configs that are wrong so its allowed to pass through unaltered.
  #
  # Extract all string values to local variables.
  event_owner                      = event.sprintf(@event_owner)
  shipper_kafka_datacenter         = event.sprintf(@kafka_datacenter_shipper)
  shipper_kafka_topic              = event.sprintf(@kafka_topic_shipper)
  shipper_kafka_consumer_group     = event.sprintf(@kafka_consumer_group_shipper)
  indexer_kafka_topic              = event.sprintf(@kafka_topic_indexer)
  indexer_kafka_consumer_group     = event.sprintf(@kafka_consumer_group_indexer)
  elasticsearch_cluster            = event.sprintf(@elasticsearch_cluster)
  elasticsearch_cluster_index      = event.sprintf(@elasticsearch_cluster_index)

  # Extract all the "time" related values to local variables.  This need special handling due to the Float() operation.
  #
  # We must check for a valid numberic value; if not the float operation will error out on "invalid hash error" and stop logstash pipeline
  event_time_ms                    = get_numeric(event.sprintf(@event_time_ms))
  shipper_kafka_append_time        = get_numeric(event.sprintf(@kafka_append_time_shipper))
  shipper_logstash_kafka_read_time = get_numeric(event.sprintf(@logstash_kafka_read_time_shipper))
  indexer_kafka_append_time        = get_numeric(event.sprintf(@kafka_append_time_indexer))
  indexer_logstash_kafka_read_time = get_numeric(event.sprintf(@logstash_kafka_read_time_indexer))

  # Validate the shipper data
  shipper_kafka_array = Array[shipper_kafka_datacenter, shipper_kafka_topic, shipper_kafka_consumer_group, shipper_kafka_append_time, shipper_logstash_kafka_read_time, event_owner, event_time_ms, elasticsearch_cluster, elasticsearch_cluster_index]
  if (shipper_kafka_array.any? { |text| text.nil? || text.to_s.empty? })
    @logger.debug("shipper_kafka_array invalid: Found null")
    error_string_shipper = sprintf("Error in shipper data: %s", shipper_kafka_array)
    @logger.debug(error_string_shipper)
    shipper_valid = false
  else
    @logger.debug("shipper_kafka_array valid")
    shipper_valid = true
    shipper_logstash_kafka_read_time = shipper_logstash_kafka_read_time.to_i
    shipper_kafka_append_time        = shipper_kafka_append_time.to_i
    shipper_kafka_lag_ms             = shipper_logstash_kafka_read_time - shipper_kafka_append_time
  end

  # Validate the indexer data
  indexer_kafka_array = Array[shipper_kafka_datacenter, indexer_kafka_topic, indexer_kafka_consumer_group, indexer_kafka_append_time, indexer_logstash_kafka_read_time, event_owner, event_time_ms, elasticsearch_cluster, elasticsearch_cluster_index]
  if (indexer_kafka_array.any? { |text| text.nil? || text.to_s.empty? })
    @logger.debug("indexer_kafka_array invalid: Found null")
    error_string_indexer = sprintf("Error in indexer data: %s", indexer_kafka_array)
    @logger.debug(error_string_indexer)
    indexer_valid = false
  else
    @logger.debug("indexer_kafka_array valid")
    indexer_valid = true
    indexer_logstash_kafka_read_time = indexer_logstash_kafka_read_time.to_i
    indexer_kafka_append_time        = indexer_kafka_append_time.to_i
    indexer_kafka_lag_ms             = indexer_logstash_kafka_read_time - indexer_kafka_append_time
  end

  # Add in the size of the payload field if it exist
  if event.get("[payload]")
    # pipeline gets random poison pill that crashes KTM with error: "error=>"(NoMethodError) undefined method `bytesize' for #Hash:0x38fe76d4", :exception=>Java::OrgJrubyExceptions::NoMethodError"
    # This should prevent the crash and log the error
    begin
      payload_size_bytes = event.get("[payload]").bytesize
    rescue NoMethodError => e
      payload_size_bytes = 0
      @logger.fatal("payload bytesize operation failed: #{e.message}")
    end
  else
    payload_size_bytes = 0
  end

  # Set time (nanoseconds) for event that is generated
  epoch_time_ns = nil
  if (event_time_ms != nil )
    epoch_time_ns = event_time_ms * 1000000
  end

  # Create array to hold one or more ktm metric events
  ktm_metric_event_array = Array.new

  # Populate the event and set tags
  if (shipper_valid == true && indexer_valid == true && epoch_time_ns != nil)
    total_kafka_lag_ms = indexer_logstash_kafka_read_time - shipper_kafka_append_time

    point_ktm = create_point_ktm(shipper_kafka_datacenter, event_owner, payload_size_bytes, "total", total_kafka_lag_ms, epoch_time_ns, elasticsearch_cluster, elasticsearch_cluster_index)
    ktm_metric_event_array.push point_ktm

  elsif (shipper_valid == true && indexer_valid == false && epoch_time_ns != nil)
    point_ktm = create_point_ktm(shipper_kafka_datacenter, event_owner, payload_size_bytes, "shipper", shipper_kafka_lag_ms, epoch_time_ns, elasticsearch_cluster, elasticsearch_cluster_index)
    ktm_metric_event_array.push point_ktm

    point_ktm = create_point_ktm_error(shipper_kafka_datacenter, event_owner, epoch_time_ns, "indexer", elasticsearch_cluster, elasticsearch_cluster_index)
    ktm_metric_event_array.push point_ktm

  elsif (indexer_valid == true && shipper_valid == false && epoch_time_ns != nil)
    point_ktm = create_point_ktm(shipper_kafka_datacenter, event_owner, payload_size_bytes, "indexer", indexer_kafka_lag_ms, epoch_time_ns, elasticsearch_cluster, elasticsearch_cluster_index)
    ktm_metric_event_array.push point_ktm

    point_ktm = create_point_ktm_error(shipper_kafka_datacenter, event_owner, epoch_time_ns, "shipper", elasticsearch_cluster, elasticsearch_cluster_index)
    ktm_metric_event_array.push point_ktm

  elsif (indexer_valid == false && shipper_valid == false)

    point_ktm = create_point_ktm_error(shipper_kafka_datacenter, event_owner, epoch_time_ns, "insufficient_data", elasticsearch_cluster, elasticsearch_cluster_index)
    ktm_metric_event_array.push point_ktm

    error_string = sprintf("Error kafka_time_machine: Could not build valid response --> %s, %s", error_string_shipper, error_string_indexer)
    @logger.debug(error_string)

  else

    point_ktm = create_point_ktm_error(shipper_kafka_datacenter, event_owner, epoch_time_ns, "unknown", elasticsearch_cluster, elasticsearch_cluster_index)
    ktm_metric_event_array.push point_ktm

    error_string = "Unknown error encountered"
    @logger.debug(error_string)

  end

  # Publish even event in our array
  ktm_metric_event_array.each do |metric_event|

    # Create new event for KTM metric
    event_ktm = LogStash::Event.new(metric_event)
    event_ktm.set("[@metadata][ktm_tags][ktm_metric]", "true")

    filter_matched(event_ktm)
    yield event_ktm

  end

end

#get_numeric(input_str) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/logstash/filters/kafka_time_machine.rb', line 253

def get_numeric(input_str)

  # @logger.debug("Aggregate timeout for '#{@task_id}' pattern: #{@timeout} seconds")
  @logger.debug("get_numeric operating on: #{input_str} ")

  is_numeric = input_str.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/) == nil ? false : true
  if (true == is_numeric)
    @logger.debug("get_numeric - valid value provided")
    num_value = Float(sprintf(input_str))

    if (false == num_value.positive?)
      @logger.debug("get_numeric - negative value provided")
      num_value = nil
    end

  else
    @logger.debug("get_numeric - invalid value provided")
    num_value = nil
  end

  @logger.debug(sprintf("get_numeric response --> #{num_value}"))

  return num_value

end

#register ⇒ Object 



51
52
53
 
# File 'lib/logstash/filters/kafka_time_machine.rb', line 51

def register

end