Module: LogstashRails

Defined in:
lib/logstash_rails.rb,
lib/logstash_rails/version.rb,
lib/logstash_rails/formatter.rb,
lib/logstash_rails/transport.rb,
lib/logstash_rails/formatter_base.rb,
lib/logstash_rails/transport_base.rb,
lib/logstash_rails/formatter/basic.rb,
lib/logstash_rails/transport/redis.rb,
lib/logstash_rails/formatter/source.rb,
lib/logstash_rails/transport/logfile.rb,
lib/logstash_rails/transport/logstash_tcp.rb,
lib/logstash_rails/transport/logstash_udp.rb,
lib/logstash_rails/formatter/flatten_params.rb

Defined Under Namespace

Modules: Formatter, Transport Classes: FormatterBase, TransportBase

Constant Summary collapse

VERSION =
"0.3.0"

Class Method Summary collapse

Class Method Details

.config(options) ⇒ Object

configure LogstashRails

Parameters:

  • options (Hash)

    configuration options

Options Hash (options):

  • :transport (Symbol)

    The transport to use.

  • :events (Array<String, Regexp>)

    The list of events to subscribe

  • :logger (Logger)

    The logger for exceptions

  • :flatten_params (Boolean)

    Flatten params hash of process_action.action_controller events (Hash with only one level). Defaults to true

Returns:

  • the configured transport

Raises:

  • (KeyError)

    if no transport has been specified

See Also:



28
29
30
31
# File 'lib/logstash_rails.rb', line 28

def self.config(options)
  formatter = LogstashRails::Formatter.get(options)
  LogstashRails::Transport.get(options.fetch(:transport)).new(formatter, options)
end