Module: Fluent::ElasticsearchIndexTemplate

Included in:
Plugin::ElasticsearchOutput
Defined in:
lib/fluent/plugin/elasticsearch_index_template.rb

Instance Method Summary collapse

Instance Method Details

#get_custom_template(template_file, customize_template) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 13

def get_custom_template(template_file, customize_template)
  if !File.exists?(template_file)
    raise "If you specify a template_name you must specify a valid template file (checked '#{template_file}')!"
  end
  file_contents = IO.read(template_file).gsub(/\n/,'')
  customize_template.each do |key, value|
    file_contents = file_contents.gsub(key,value.downcase)
  end
  JSON.parse(file_contents)
end

#get_template(template_file) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 5

def get_template(template_file)
  if !File.exists?(template_file)
    raise "If you specify a template_name you must specify a valid template file (checked '#{template_file}')!"
  end
  file_contents = IO.read(template_file).gsub(/\n/,'')
  JSON.parse(file_contents)
end

#indexcreation(index_name) ⇒ Object 



58
59
60
61
62
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 58

def indexcreation(index_name)
  client.indices.create(:index => index_name)
  rescue Elasticsearch::Transport::Transport::Error => e
    log.error("Error while index creation - #{index_name}: #{e.inspect}")
end

#retry_operate(max_retries, fail_on_retry_exceed = true) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 31

def retry_operate(max_retries, fail_on_retry_exceed = true)
  return unless block_given?
  retries = 0
  begin
    yield
  rescue *client.transport.host_unreachable_exceptions, Timeout::Error => e
    @_es = nil
    @_es_info = nil
    if retries < max_retries
      retries += 1
      wait_seconds = 2**retries
      sleep wait_seconds
      log.warn "Could not communicate to Elasticsearch, resetting connection and trying again. #{e.message}"
      log.warn "Remaining retry: #{max_retries - retries}. Retry to communicate after #{wait_seconds} second(s)."
      retry
    end
    message = "Could not communicate to Elasticsearch after #{retries} retries. #{e.message}"
    log.warn message
    raise Fluent::Plugin::ElasticsearchError::RetryableOperationExhaustedFailure,
          message if fail_on_retry_exceed
  end
end

#template_custom_install(template_name, template_file, overwrite, customize_template, index_prefix, rollover_index, deflector_alias_name, app_name, index_date_pattern) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 78

def template_custom_install(template_name, template_file, overwrite, customize_template, index_prefix, rollover_index, deflector_alias_name, app_name, index_date_pattern)
  template_custom_name=template_name.downcase
  if overwrite
    template_put(template_custom_name, get_custom_template(template_file, customize_template))
    log.info("Template '#{template_custom_name}' overwritten with #{template_file}.")
  else
    if !template_exists?(template_custom_name)
      template_put(template_custom_name, get_custom_template(template_file, customize_template))
      log.info("Template configured, but no template installed. Installed '#{template_custom_name}' from #{template_file}.")
    else
      log.info("Template configured and already installed.")
    end
  end

  if rollover_index
    if !client.indices.exists_alias(:name => deflector_alias_name)
      index_name_temp='<'+index_prefix.downcase+'-'+app_name.downcase+'-{'+index_date_pattern+'}-000001>'
      indexcreation(index_name_temp)
      client.indices.put_alias(:index => index_name_temp, :name => deflector_alias_name)
      log.info("The alias '#{deflector_alias_name}' is created for the index '#{index_name_temp}'")
    else
      log.info("The alias '#{deflector_alias_name}' is already present")
    end
  else
    log.info("No index and alias creation action performed because rollover_index is set to '#{rollover_index}'")
  end
end

#template_exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
27
28
29
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 24

def template_exists?(name)
  client.indices.get_template(:name => name)
  return true
rescue Elasticsearch::Transport::Transport::Errors::NotFound
  return false
end

#template_install(name, template_file, overwrite) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 64

def template_install(name, template_file, overwrite)
  if overwrite
    template_put(name, get_template(template_file))
    log.info("Template '#{name}' overwritten with #{template_file}.")
    return
  end
  if !template_exists?(name)
    template_put(name, get_template(template_file))
    log.info("Template configured, but no template installed. Installed '#{name}' from #{template_file}.")
  else
    log.info("Template configured and already installed.")
  end
end

#template_put(name, template) ⇒ Object 



54
55
56
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 54

def template_put(name, template)
  client.indices.put_template(:name => name, :body => template)
end

#templates_hash_install(templates, overwrite) ⇒ Object 



106
107
108
109
110
 
# File 'lib/fluent/plugin/elasticsearch_index_template.rb', line 106

def templates_hash_install(templates, overwrite)
  templates.each do |key, value|
    template_install(key, value, overwrite)
  end
end