Class: LogStash::Agent

Inherits:
Clamp::Command
  • Object
show all
Defined in:
lib/logstash/agent.rb

Constant Summary collapse

DEFAULT_INPUT = 
"input { stdin { type => stdin } }"
DEFAULT_OUTPUT = 
"output { stdout { codec => rubydebug } }"

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Agent

Returns a new instance of Agent.



73
74
75
76
 
# File 'lib/logstash/agent.rb', line 73

def initialize(*args)
  super(*args)
  @pipeline_settings ||= { :pipeline_id => "base" }
end

Instance Method Details

#configure ⇒ Object

Do any start-time configuration.

Log file stuff, plugin path checking, etc.



272
273
274
275
 
# File 'lib/logstash/agent.rb', line 272

def configure
  configure_logging(log_file)
  configure_plugin_paths(plugin_paths)
end

#configure_logging(path) ⇒ Object

Point logging at a specific path.



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/logstash/agent.rb', line 278

def configure_logging(path)
  # Set with the -v (or -vv...) flag
  if quiet?
    @logger.level = :error
  elsif verbose?
    @logger.level = :info
  elsif debug?
    @logger.level = :debug
  else
    # Old support for the -v and -vv stuff.
    if verbosity? && verbosity?.any?
      # this is an array with length of how many times the flag is given
      if verbosity?.length == 1
        @logger.warn("The -v flag is deprecated and will be removed in a future release. You should use --verbose instead.")
        @logger.level = :info
      else
        @logger.warn("The -vv flag is deprecated and will be removed in a future release. You should use --debug instead.")
        @logger.level = :debug
      end
    else
      @logger.level = :warn
    end
  end

  if log_file
    # TODO(sissel): Implement file output/rotation in Cabin.
    # TODO(sissel): Catch exceptions, report sane errors.
    begin
      @log_fd.close if @log_fd
      @log_fd = File.new(path, "a")
    rescue => e
      fail(I18n.t("logstash.agent.configuration.log_file_failed",
                  :path => path, :error => e))
    end

    puts "Sending logstash logs to #{path}."
    @logger.unsubscribe(@logger_subscription) if @logger_subscription
    @logger_subscription = @logger.subscribe(@log_fd)
  else
    @logger.subscribe(STDOUT)
  end

  # TODO(sissel): redirect stdout/stderr to the log as well
  # http://jira.codehaus.org/browse/JRUBY-7003
end

#configure_plugin_paths(paths) ⇒ Object

add the given paths for ungemified/bare plugins lookups

Parameters:

  • paths (String, Array<String>) —

    plugins path string or list of path strings to add



326
327
328
329
330
331
 
# File 'lib/logstash/agent.rb', line 326

def configure_plugin_paths(paths)
  Array(paths).each do |path|
    fail(I18n.t("logstash.agent.configuration.plugin_path_missing", :path => path)) unless File.directory?(path)
    LogStash::Environment.add_plugin_path(path)
  end
end

#execute ⇒ Object

Run the agent. This method is invoked after clamp parses the flags given to this program.



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/logstash/agent.rb', line 118

def execute
  require "logstash/pipeline"
  require "cabin" # gem 'cabin'
  require "logstash/plugin"
  @logger = Cabin::Channel.get(LogStash)

  LogStash::ShutdownWatcher.unsafe_shutdown = unsafe_shutdown?
  LogStash::ShutdownWatcher.logger = @logger

  if version?
    show_version
    return 0
  end

  # temporarily send logs to stdout as well if a --log is specified
  # and stdout appears to be a tty
  show_startup_errors = log_file && STDOUT.tty?

  if show_startup_errors
    stdout_logs = @logger.subscribe(STDOUT)
  end
  configure


  if filter_workers
    @logger.warn("--filter-workers is deprecated! Please use --pipeline-workers or -w. This setting will be removed in the next major version!")
    self.pipeline_workers = filter_workers
  end

  # You must specify a config_string or config_path
  if @config_string.nil? && @config_path.nil?
    fail(help + "\n" + I18n.t("logstash.agent.missing-configuration"))
  end

  @config_string = @config_string.to_s

  if @config_path
    # Append the config string.
    # This allows users to provide both -f and -e flags. The combination
    # is rare, but useful for debugging.
    @config_string = @config_string + load_config(@config_path)
  else
    # include a default stdin input if no inputs given
    if @config_string !~ /input *{/
      @config_string += DEFAULT_INPUT
    end
    # include a default stdout output if no outputs given
    if @config_string !~ /output *{/
      @config_string += DEFAULT_OUTPUT
    end
  end


  begin
    pipeline = LogStash::Pipeline.new(@config_string, @pipeline_settings)
  rescue LoadError => e
    fail("Configuration problem.")
  end

  # Make SIGINT shutdown the pipeline.
  sigint_id = Stud::trap("INT") do

    if @interrupted_once
      @logger.fatal(I18n.t("logstash.agent.forced_sigint"))
      exit
    else
      @logger.warn(I18n.t("logstash.agent.sigint"))
      Thread.new(@logger) {|logger| sleep 5; logger.warn(I18n.t("logstash.agent.slow_shutdown")) }
      @interrupted_once = true
      shutdown(pipeline)
    end
  end

  # Make SIGTERM shutdown the pipeline.
  sigterm_id = Stud::trap("TERM") do
    @logger.warn(I18n.t("logstash.agent.sigterm"))
    shutdown(pipeline)
  end

  Stud::trap("HUP") do
    @logger.info(I18n.t("logstash.agent.sighup"))
    configure_logging(log_file)
  end

  # Stop now if we are only asking for a config test.
  if config_test?
    report "Configuration OK"
    return
  end

  @logger.unsubscribe(stdout_logs) if show_startup_errors

  # TODO(sissel): Get pipeline completion status.
  pipeline.run
  return 0
rescue LogStash::ConfigurationError => e
  @logger.unsubscribe(stdout_logs) if show_startup_errors
  report I18n.t("logstash.agent.error", :error => e)
  if !config_test?
    report I18n.t("logstash.agent.configtest-flag-information")
  end
  return 1
rescue => e
  @logger.unsubscribe(stdout_logs) if show_startup_errors
  report I18n.t("oops", :error => e)
  report e.backtrace if @logger.debug? || $DEBUGLIST.include?("stacktrace")
  return 1
ensure
  @log_fd.close if @log_fd
  Stud::untrap("INT", sigint_id) unless sigint_id.nil?
  Stud::untrap("TERM", sigterm_id) unless sigterm_id.nil?
end

#fail(message) ⇒ Object

Emit a failure message and abort.

Raises:



106
107
108
 
# File 'lib/logstash/agent.rb', line 106

def fail(message)
  raise LogStash::ConfigurationError, message
end

#fetch_config(uri) ⇒ Object

def load_config



384
385
386
387
388
389
390
 
# File 'lib/logstash/agent.rb', line 384

def fetch_config(uri)
  begin
    Net::HTTP.get(uri) + "\n"
  rescue Exception => e
    fail(I18n.t("logstash.agent.configuration.fetch-failed", :path => uri.to_s, :message => e.message))
  end
end

#load_config(path) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/logstash/agent.rb', line 333

def load_config(path)
  begin
    uri = URI.parse(path)

    case uri.scheme
    when nil then
      local_config(path)
    when /http/ then
      fetch_config(uri)
    when "file" then
      local_config(uri.path)
    else
      fail(I18n.t("logstash.agent.configuration.scheme-not-supported", :path => path))
    end
  rescue URI::InvalidURIError
    # fallback for windows.
    # if the parsing of the file failed we assume we can reach it locally.
    # some relative path on windows arent parsed correctly (.\logstash.conf)
    local_config(path)
  end
end

#local_config(path) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/logstash/agent.rb', line 355

def local_config(path)
  path = File.expand_path(path)
  path = File.join(path, "*") if File.directory?(path)

  if Dir.glob(path).length == 0
    fail(I18n.t("logstash.agent.configuration.file-not-found", :path => path))
  end

  config = ""
  encoding_issue_files = []
  Dir.glob(path).sort.each do |file|
    next unless File.file?(file)
    if file.match(/~$/)
      @logger.debug("NOT reading config file because it is a temp file", :file => file)
      next
    end
    @logger.debug("Reading config file", :file => file)
    cfg = File.read(file)
    if !cfg.ascii_only? && !cfg.valid_encoding?
      encoding_issue_files << file
    end
    config << cfg + "\n"
  end
  if (encoding_issue_files.any?)
    fail("The following config files contains non-ascii characters but are not UTF-8 encoded #{encoding_issue_files}")
  end
  return config
end

#pipeline_batch_delay=(pipeline_batch_delay_value) ⇒ Object 



86
87
88
 
# File 'lib/logstash/agent.rb', line 86

def pipeline_batch_delay=(pipeline_batch_delay_value)
  @pipeline_settings[:pipeline_batch_delay] = validate_positive_integer(pipeline_batch_delay_value)
end

#pipeline_batch_size=(pipeline_batch_size_value) ⇒ Object 



82
83
84
 
# File 'lib/logstash/agent.rb', line 82

def pipeline_batch_size=(pipeline_batch_size_value)
  @pipeline_settings[:pipeline_batch_size] = validate_positive_integer(pipeline_batch_size_value)
end

#pipeline_workers=(pipeline_workers_value) ⇒ Object 



78
79
80
 
# File 'lib/logstash/agent.rb', line 78

def pipeline_workers=(pipeline_workers_value)
  @pipeline_settings[:pipeline_workers] = validate_positive_integer(pipeline_workers_value)
end

#report(message) ⇒ Object

def fail



110
111
112
113
114
 
# File 'lib/logstash/agent.rb', line 110

def report(message)
  # Print to stdout just in case we're logging to a file
  puts message
  @logger.log(message) if log_file
end

#show_gems ⇒ Object

def show_version_java



262
263
264
265
266
267
 
# File 'lib/logstash/agent.rb', line 262

def show_gems
  require "rubygems"
  Gem::Specification.each do |spec|
    puts "gem #{spec.name} #{spec.version}"
  end
end

#show_version ⇒ Object 



237
238
239
240
241
242
243
244
245
 
# File 'lib/logstash/agent.rb', line 237

def show_version
  show_version_logstash

  if [:info, :debug].include?(verbosity?) || debug? || verbose?
    show_version_ruby
    show_version_java if LogStash::Environment.jruby?
    show_gems if [:debug].include?(verbosity?) || debug?
  end
end

#show_version_java ⇒ Object

def show_version_ruby



256
257
258
259
260
 
# File 'lib/logstash/agent.rb', line 256

def show_version_java
  properties = java.lang.System.getProperties
  puts "java #{properties["java.version"]} (#{properties["java.vendor"]})"
  puts "jvm #{properties["java.vm.name"]} / #{properties["java.vm.version"]}"
end

#show_version_logstash ⇒ Object

def show_version



247
248
249
250
 
# File 'lib/logstash/agent.rb', line 247

def show_version_logstash
  require "logstash/version"
  puts "logstash #{LOGSTASH_VERSION}"
end

#show_version_ruby ⇒ Object

def show_version_logstash



252
253
254
 
# File 'lib/logstash/agent.rb', line 252

def show_version_ruby
  puts RUBY_DESCRIPTION
end

#shutdown(pipeline) ⇒ Object

def execute



231
232
233
234
235
 
# File 'lib/logstash/agent.rb', line 231

def shutdown(pipeline)
  pipeline.shutdown do
    ::LogStash::ShutdownWatcher.start(pipeline)
  end
end

#validate_positive_integer(str_arg) ⇒ Object 



90
91
92
93
94
95
96
97
 
# File 'lib/logstash/agent.rb', line 90

def validate_positive_integer(str_arg)
  int_arg = str_arg.to_i
  if str_arg !~ /^\d+$/ || int_arg < 1
    raise ArgumentError, "Expected a positive integer, got '#{str_arg}'"
  end

  int_arg
end

#warn(message) ⇒ Object

Emit a warning message.

Raises:



100
101
102
103
 
# File 'lib/logstash/agent.rb', line 100

def warn(message)
  # For now, all warnings are fatal.
  raise LogStash::ConfigurationError, message
end