Class: Fluent::SyslogOutput

Inherits:
Output
  • Object
show all
Defined in:
lib/fluentd/plugin/out_syslog.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SyslogOutput

Returns a new instance of SyslogOutput.



22
23
24
25
26
 
# File 'lib/fluentd/plugin/out_syslog.rb', line 22

def initialize
  super
  require 'socket'
  require 'syslog_protocol'
end

Instance Method Details

#configure(conf) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/fluentd/plugin/out_syslog.rb', line 28

def configure(conf)
  super
  if not conf['remote_syslog']
    raise Fluent::ConfigError.new("remote syslog required")
  end
  @socket = UDPSocket.new
  @packet = SyslogProtocol::Packet.new
  if remove_tag_prefix = conf['remove_tag_prefix']
      @remove_tag_prefix = Regexp.new('^' + Regexp.escape(remove_tag_prefix))
  end
  @facilty = conf['facility']
  @severity = conf['severity']
  @use_record = conf['use_record']
  @payload_key = conf['payload_key']
  if not @payload_key
    @payload_key = "message"
  end
end

#emit(tag, es, chain) ⇒ Object

This method is called when an event reaches Fluentd. ‘es’ is a Fluent::EventStream object that includes multiple events. You can use ‘es.each {|time,record| … }’ to retrieve events. ‘chain’ is an object that manages transactions. Call ‘chain.next’ at appropriate points and rollback if it raises an exception.



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
 
# File 'lib/fluentd/plugin/out_syslog.rb', line 63

def emit(tag, es, chain)
  tag = tag.sub(@remove_tag_prefix, '') if @remove_tag_prefix
  chain.next
  es.each {|time,record|
    @packet.hostname = hostname
    if @use_record
      @packet.facility = record['facility'] || @facilty
      @packet.severity = record['severity'] || @severity
    else
      @packet.facility = @facilty
      @packet.severity = @severity
    end
    if record['time']
      time = Time.parse(record['time'])
    else
      time = Time.now
    end
    @packet.time = time
    @packet.tag      = if tag_key
                          record[tag_key][0..31].gsub(/[\[\]]/,'') # tag is trimmed to 32 chars for syslog_protocol gem compatibility
                       else
                          tag[0..31] # tag is trimmed to 32 chars for syslog_protocol gem compatibility
                       end
    packet = @packet.dup
    packet.content = record[@payload_key]
    @socket.send(packet.assemble, 0, @remote_syslog, @port)
}
end

#shutdown ⇒ Object

This method is called when shutting down.



54
55
56
 
# File 'lib/fluentd/plugin/out_syslog.rb', line 54

def shutdown
  super
end

#start ⇒ Object

This method is called when starting.



49
50
51
 
# File 'lib/fluentd/plugin/out_syslog.rb', line 49

def start
  super
end