Class: Fluent::ElasticsearchOutput

Inherits:
BufferedOutput
  • Object
show all
Includes:
SetTagKeyMixin
Defined in:
lib/fluent/plugin/out_elasticsearch.rb

Direct Known Subclasses

ElasticsearchOutputDynamic

Defined Under Namespace

Classes: ConnectionFailure

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ElasticsearchOutput

Returns a new instance of ElasticsearchOutput.



42
43
44
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 42

def initialize
  super
end

Instance Method Details

#append_record_to_messages(op, meta, record, msgs) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 131

def append_record_to_messages(op, meta, record, msgs)
  case op
  when "update", "upsert"
    if meta.has_key?("_id")
      msgs << { "update" => meta }
      msgs << { "doc" => record, "doc_as_upsert" => op == "upsert" }
    end
  when "create"
    if meta.has_key?("_id")
      msgs << { "create" => meta }
      msgs << record
    end        
  when "index"
    msgs << { "index" => meta }
    msgs << record
  end
end

#client ⇒ Object 



54
55
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
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 54

def client
  @_es ||= begin
    excon_options = { client_key: @client_key, client_cert: @client_cert, client_key_pass: @client_key_pass }
    adapter_conf = lambda {|f| f.adapter :excon, excon_options }
    transport = Elasticsearch::Transport::Transport::HTTP::Faraday.new(get_connection_options.merge(
                                                                        options: {
                                                                          reload_connections: @reload_connections,
                                                                          reload_on_failure: @reload_on_failure,
                                                                          resurrect_after: @resurrect_after,
                                                                          retry_on_failure: 5,
                                                                          transport_options: {
                                                                            request: { timeout: @request_timeout },
                                                                            ssl: { verify: @ssl_verify, ca_file: @ca_file }
                                                                          }
                                                                        }), &adapter_conf)
    es = Elasticsearch::Client.new transport: transport

    begin
      raise ConnectionFailure, "Can not reach Elasticsearch cluster (#{connection_options_description})!" unless es.ping
    rescue *es.transport.host_unreachable_exceptions => e
      raise ConnectionFailure, "Can not reach Elasticsearch cluster (#{connection_options_description})! #{e.message}"
    end

    log.info "Connection opened to Elasticsearch cluster => #{connection_options_description}"
    es
  end
end

#configure(conf) ⇒ Object 



46
47
48
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 46

def configure(conf)
  super
end

#connection_options_description ⇒ Object 



115
116
117
118
119
120
121
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 115

def connection_options_description
  get_connection_options[:hosts].map do |host_info|
    attributes = host_info.dup
    attributes[:password] = 'obfuscated' if attributes.has_key?(:password)
    attributes.inspect
  end.join(', ')
end

#format(tag, time, record) ⇒ Object 



123
124
125
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 123

def format(tag, time, record)
  [tag, time, record].to_msgpack
end

#get_connection_options ⇒ Object 



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
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 82

def get_connection_options
  raise "`password` must be present if `user` is present" if @user && !@password

  hosts = if @hosts
    @hosts.split(',').map do |host_str|
      # Support legacy hosts format host:port,host:port,host:port...
      if host_str.match(%r{^[^:]+(\:\d+)?$})
        {
          host:   host_str.split(':')[0],
          port:   (host_str.split(':')[1] || @port).to_i,
          scheme: @scheme
        }
      else
        # New hosts format expects URLs such as http://logs.foo.com,https://john:[email protected]/elastic
        uri = URI(host_str)
        %w(user password path).inject(host: uri.host, port: uri.port, scheme: uri.scheme) do |hash, key|
          hash[key.to_sym] = uri.public_send(key) unless uri.public_send(key).nil? || uri.public_send(key) == ''
          hash
        end
      end
    end.compact
  else
    [{host: @host, port: @port, scheme: @scheme}]
  end.each do |host|
    host.merge!(user: @user, password: @password) if !host[:user] && @user
    host.merge!(path: @path) if !host[:path] && @path
  end

  {
    hosts: hosts
  }
end

#send(data) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 192

def send(data)
  retries = 0
  begin
    client.bulk body: data
  rescue *client.transport.host_unreachable_exceptions => e
    if retries < 2
      retries += 1
      @_es = nil
      log.warn "Could not push logs to Elasticsearch, resetting connection and trying again. #{e.message}"
      sleep 2**retries
      retry
    end
    raise ConnectionFailure, "Could not push logs to Elasticsearch after #{retries} retries. #{e.message}"
  end
end

#shutdown ⇒ Object 



127
128
129
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 127

def shutdown
  super
end

#start ⇒ Object 



50
51
52
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 50

def start
  super
end

#write(chunk) ⇒ Object 



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
 
# File 'lib/fluent/plugin/out_elasticsearch.rb', line 149

def write(chunk)
  bulk_message = []

  chunk.msgpack_each do |tag, time, record|
    next unless record.is_a? Hash
    if @logstash_format
      if record.has_key?("@timestamp")
        time = Time.parse record["@timestamp"]
      elsif record.has_key?(@time_key)
        time = Time.parse record[@time_key]
        record['@timestamp'] = record[@time_key]
      else
        record.merge!({"@timestamp" => Time.at(time).to_datetime.to_s})
      end
      if @utc_index
        target_index = "#{@logstash_prefix}-#{Time.at(time).getutc.strftime("#{@logstash_dateformat}")}"
      else
        target_index = "#{@logstash_prefix}-#{Time.at(time).strftime("#{@logstash_dateformat}")}"
      end
    else
      target_index = @index_name
    end

    if @include_tag_key
      record.merge!(@tag_key => tag)
    end

    meta = {"_index" => target_index, "_type" => type_name}
    if @id_key && record[@id_key]
      meta['_id'] = record[@id_key]
    end

    if @parent_key && record[@parent_key]
      meta['_parent'] = record[@parent_key]
    end

    append_record_to_messages(@write_operation, meta, record, bulk_message)
  end

  send(bulk_message) unless bulk_message.empty?
  bulk_message.clear
end