Class: SemanticLogger::Appender::Graylog

Inherits:
Base
  • Object
show all
Defined in:
lib/semantic_logger/appender/graylog.rb

Overview

Forward log entries to a Graylog server.

Example:

appender        = SemanticLogger::Appender::Graylog.new(
  url: 'udp://localhost:12201'
)

# Optional: Add filter to exclude health_check, or other log entries
appender.filter = Proc.new { |log| log.message !~ /(health_check|Not logged in)/ }

SemanticLogger.add_appender(appender)

Notes:

  • trace is not supported by Graylog, so trace level logging will appear as debug in Graylog.

In the Graylog Web UI search screen, it is recommended to include the following fields:

`duration`, `level`, `message`, `metric`, `name`, `tags

Constant Summary collapse

LEVEL_MAP =

Map Semantic Logger levels to Graylog levels

{
  fatal: GELF::FATAL,
  error: GELF::ERROR,
  warn:  GELF::WARN,
  info:  GELF::INFO,
  debug: GELF::DEBUG,
  trace: GELF::DEBUG
}

Instance Attribute Summary collapse

Attributes inherited from Base

#formatter

Attributes inherited from Base

#filter, #name

Instance Method Summary collapse

Methods inherited from Base

colorized_formatter, #flush, json_formatter, #level

Methods inherited from Base

#benchmark, default_level, default_level=, #fast_tag, #level, #level=, #payload, #pop_tags, #push_tags, #silence, #tagged, #tags, #with_payload

Constructor Details

#initialize(options = {}, &block) ⇒ Graylog

Create Graylog log appender.

Options:

url: [String]
  Valid URL to post to.
  Log to UDP Example:
    'udp://localhost:12201'
  Log to TCP Example:
    'tcp://localhost:12201'
  Default: 'udp://localhost:12201'

host: [String]
  Name of this host to appear in log messages.
  Default: Socket.gethostname

application: [String]
  Name of this application to appear in log messages.
  Default: SemanticLogger.application

max_size: [String]
  Max udp packet size. Ignored when protocol is :tcp
  Default: "WAN"

level: [:trace | :debug | :info | :warn | :error | :fatal]
  Override the log level for this appender.
  Default: SemanticLogger.default_level

filter: [Regexp|Proc]
  RegExp: Only include log messages where the class name matches the supplied.
  regular expression. All other messages will be ignored.
  Proc: Only include log messages where the supplied Proc returns true
        The Proc must return true or false.

Raises:

  • (ArgumentError) 


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/semantic_logger/appender/graylog.rb', line 70

def initialize(options = {}, &block)
  @options  = options.dup
  level     = @options.delete(:level)
  filter    = @options.delete(:filter)
  @url      = options.delete(:url) || 'udp://localhost:12201'
  @max_size = @options.delete(:max_size) || 'WAN'

  uri      = URI.parse(@url)
  @server  = uri.host
  @port    = uri.port
  protocol = uri.scheme.to_sym

  raise(ArgumentError, "Invalid protocol value: #{protocol}. Must be :udp or :tcp") unless [:udp, :tcp].include?(protocol)

  @options[:protocol] = protocol == :tcp ? GELF::Protocol::TCP : GELF::Protocol::UDP
  @options[:facility] = @options.delete(:application) || SemanticLogger.application
  reopen
  super(level, filter, &block)
end

Instance Attribute Details

#notifier ⇒ Object (readonly)

Returns the value of attribute notifier.



36
37
38
 
# File 'lib/semantic_logger/appender/graylog.rb', line 36

def notifier
  @notifier
end

Instance Method Details

#default_formatter ⇒ Object

Returns [Hash] of parameters to send



97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/semantic_logger/appender/graylog.rb', line 97

def default_formatter
  Proc.new do |log, logger|
    h = log.to_h
    h.delete(:time)
    h[:timestamp]     = log.time.utc.to_f
    h[:level]         = logger.map_level(log)
    h[:level_str]     = log.level.to_s
    h[:short_message] = h.delete(:message) if log.message
    h
  end
end

#log(log) ⇒ Object

Forward log messages



110
111
112
113
114
115
116
 
# File 'lib/semantic_logger/appender/graylog.rb', line 110

def log(log)
  return false if (level_index > (log.level_index || 0)) ||
    !include_message?(log) # Filtered out?

  @notifier.notify!(formatter.call(log, self))
  true
end

#map_level(log) ⇒ Object

Returns the Graylog level for the supplied log message



119
120
121
 
# File 'lib/semantic_logger/appender/graylog.rb', line 119

def map_level(log)
  LEVEL_MAP[log.level]
end

#reopen ⇒ Object

Re-open after process fork



91
92
93
94
 
# File 'lib/semantic_logger/appender/graylog.rb', line 91

def reopen
  @notifier                       = GELF::Notifier.new(@server, @port, @max_size, @options)
  @notifier.collect_file_and_line = false
end