Class: LogStash::Config::ModulesCommon

Inherits:
Object
  • Object
show all
Includes:
Util::Loggable
Defined in:
lib/logstash/config/modules_common.rb

Overview

extracted here for bwc with 5.x

Constant Summary collapse

MODULES_MAX_PIPELINES = 
1

Class Method Summary collapse

Class Method Details

.pipeline_configs(settings) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
81
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
 
# File 'lib/logstash/config/modules_common.rb', line 14

def self.pipeline_configs(settings)
  pipelines = []
  plugin_modules = LogStash::PLUGIN_REGISTRY.plugins_with_type(:modules)

  cli_settings = settings.get("modules.cli")
  yml_settings = settings.get("modules")

  modules_array = if !(cli_settings.empty? && yml_settings.empty?)
        LogStash::Modules::SettingsMerger.merge(cli_settings, yml_settings)
      elsif cli_settings.empty?
         yml_settings
      else
        cli_settings
      end

  if modules_array.empty?
    # no specified modules
    return pipelines
  end
  logger.debug("Specified modules", :modules_array => modules_array.to_s)

  module_names = modules_array.collect {|module_hash| module_hash["name"]}
  if module_names.size > MODULES_MAX_PIPELINES
    error_message = I18n.t("logstash.modules.configuration.modules-too-many-specified", :max => MODULES_MAX_PIPELINES, :specified_modules => module_names.join(', '))
    raise LogStash::ConfigLoadingError, error_message
  end

  if module_names.length > module_names.uniq.length
    duplicate_modules = module_names.group_by(&:to_s).select { |_,v| v.size > 1 }.keys
    raise LogStash::ConfigLoadingError, I18n.t("logstash.modules.configuration.modules-must-be-unique", :duplicate_modules => duplicate_modules)
  end

  available_module_names = plugin_modules.map(&:module_name)
  specified_and_available_names = module_names & available_module_names

  if (specified_and_available_names).empty?
    i18n_opts = {:specified_modules => module_names, :available_modules => available_module_names}
    raise LogStash::ConfigLoadingError, I18n.t("logstash.modules.configuration.modules-unavailable", i18n_opts)
  end

  specified_and_available_names.each do |module_name|
    connect_fail_args = {}
    begin
      module_settings = settings.clone

      module_hash = modules_array.find {|m| m["name"] == module_name}
      current_module = plugin_modules.find { |allmodules| allmodules.module_name == module_name }

      enabled = current_module.is_enabled?(module_settings)
      unless enabled
        logger.warn("The #{module_name} module is not enabled. Please check the logs for additional information.")
        next
      end


      alt_name = "module-#{module_name}"
      pipeline_id = alt_name
      module_settings.set("pipeline.id", pipeline_id)
      LogStash::Modules::SettingsMerger.merge_cloud_settings(module_hash, module_settings)
      LogStash::Modules::SettingsMerger.merge_kibana_auth!(module_hash)
      current_module.with_settings(module_hash)
      config_test = settings.get("config.test_and_exit")
      module_setup = settings.get("modules_setup")
      # Only import data if it's not a config test and --setup is true
      if !config_test && module_setup
        logger.info("Setting up the #{module_name} module")
        esclient = LogStash::ElasticsearchClient.build(module_hash)
        kbnclient = LogStash::Modules::KibanaClient.new(module_hash)
        esconnected = esclient.can_connect?
        kbnconnected = kbnclient.can_connect?
        if esconnected && kbnconnected
          current_module.add_kibana_version(kbnclient.version_parts)
          current_module.import(
              LogStash::Modules::ElasticsearchImporter.new(esclient),
              LogStash::Modules::KibanaImporter.new(kbnclient)
            )
        else
          connect_fail_args[:module_name] = module_name
          connect_fail_args[:elasticsearch_hosts] = esclient.host_settings
          connect_fail_args[:kibana_hosts] = kbnclient.host_settings
        end
      else
        logger.info("Starting the #{module_name} module")
      end

      config_string = current_module.config_string
      pipelines << {"pipeline_id" => pipeline_id, "alt_name" => alt_name, "config_string" => config_string, "settings" => module_settings}
    rescue => e
      new_error = LogStash::ConfigLoadingError.new(I18n.t("logstash.modules.configuration.parse-failed", :error => e.message))
      new_error.set_backtrace(e.backtrace)
      raise new_error
    end

    if !connect_fail_args.empty?
      raise LogStash::ConfigLoadingError, I18n.t("logstash.modules.configuration.elasticsearch_connection_failed", connect_fail_args)
    end
  end
  pipelines
end