From 86e0baccf7ef1217dc5a6e7e93f091fb55bbe567 Mon Sep 17 00:00:00 2001
From: Joao Duarte <jsvduarte@gmail.com>
Date: Fri, 23 Aug 2019 15:50:53 +0100
Subject: [PATCH] give multiple pipelines all the settings

Previously we'd only give a pipeline the settings related to pipelines
The PipelineSettings class was used for this.
However a pipeline may need other settings like the keystore location.

For this we instead clone the settings object and merge all the pipeline
specific settings. This is accomplished with a new method that ensures
that only pipeline level settings are overwritten in the clone.
---
 .../lib/logstash/config/source/multi_local.rb |  5 +-
 .../lib/logstash/pipeline_settings.rb         | 55 -------------------
 logstash-core/lib/logstash/settings.rb        | 42 ++++++++++++++
 3 files changed, 45 insertions(+), 57 deletions(-)
 delete mode 100644 logstash-core/lib/logstash/pipeline_settings.rb

diff --git a/logstash-core/lib/logstash/config/source/multi_local.rb b/logstash-core/lib/logstash/config/source/multi_local.rb
index 9f546ef24a7..c2819d8a2dd 100644
--- a/logstash-core/lib/logstash/config/source/multi_local.rb
+++ b/logstash-core/lib/logstash/config/source/multi_local.rb
@@ -1,6 +1,6 @@
 # encoding: utf-8
 require "logstash/config/source/local"
-require "logstash/pipeline_settings"
+require "logstash/settings"
 
 module LogStash module Config module Source
   class MultiLocal < Local
@@ -15,7 +15,8 @@ def initialize(settings)
     def pipeline_configs
       pipelines = retrieve_yaml_pipelines()
       pipelines_settings = pipelines.map do |pipeline_settings|
-        ::LogStash::PipelineSettings.from_settings(@original_settings.clone).merge(pipeline_settings)
+        clone = @original_settings.clone
+        clone.merge_pipeline_settings(pipeline_settings)
       end
       detect_duplicate_pipelines(pipelines_settings)
       pipeline_configs = pipelines_settings.map do |pipeline_settings|
diff --git a/logstash-core/lib/logstash/pipeline_settings.rb b/logstash-core/lib/logstash/pipeline_settings.rb
deleted file mode 100644
index 9fabab3a7fe..00000000000
--- a/logstash-core/lib/logstash/pipeline_settings.rb
+++ /dev/null
@@ -1,55 +0,0 @@
-# encoding: utf-8
-require "logstash/settings"
-
-module LogStash
-  class PipelineSettings < Settings
-
-    # there are settings that the pipeline uses and can be changed per pipeline instance
-    SETTINGS_WHITE_LIST = [
-      "config.debug",
-      "config.support_escapes",
-      "config.reload.automatic",
-      "config.reload.interval",
-      "config.string",
-      "dead_letter_queue.enable",
-      "dead_letter_queue.max_bytes",
-      "metric.collect",
-      "pipeline.java_execution",
-      "pipeline.plugin_classloaders",
-      "path.config",
-      "path.dead_letter_queue",
-      "path.queue",
-      "pipeline.batch.delay",
-      "pipeline.batch.size",
-      "pipeline.id",
-      "pipeline.reloadable",
-      "pipeline.system",
-      "pipeline.workers",
-      "queue.checkpoint.acks",
-      "queue.checkpoint.interval",
-      "queue.checkpoint.writes",
-      "queue.checkpoint.retry",
-      "queue.drain",
-      "queue.max_bytes",
-      "queue.max_events",
-      "queue.page_capacity",
-      "queue.type",
-    ]
-
-    # register a set of settings that is used as the default set of pipelines settings
-    def self.from_settings(settings)
-      pipeline_settings = self.new
-      SETTINGS_WHITE_LIST.each do |setting|
-        pipeline_settings.register(settings.get_setting(setting).clone)
-      end
-      pipeline_settings
-    end
-
-    def register(setting)
-      unless SETTINGS_WHITE_LIST.include?(setting.name)
-        raise ArgumentError.new("Only pipeline related settings can be registered in a PipelineSettings object. Received \"#{setting.name}\". Allowed settings: #{SETTINGS_WHITE_LIST}")
-      end
-      super(setting)
-    end
-  end
-end
diff --git a/logstash-core/lib/logstash/settings.rb b/logstash-core/lib/logstash/settings.rb
index 94994dcaa8b..7dc594808a8 100644
--- a/logstash-core/lib/logstash/settings.rb
+++ b/logstash-core/lib/logstash/settings.rb
@@ -10,6 +10,39 @@ class Settings
     include LogStash::Util::SubstitutionVariables
     include LogStash::Util::Loggable
 
+    # there are settings that the pipeline uses and can be changed per pipeline instance
+    PIPELINE_SETTINGS_WHITE_LIST = [
+      "config.debug",
+      "config.support_escapes",
+      "config.reload.automatic",
+      "config.reload.interval",
+      "config.string",
+      "dead_letter_queue.enable",
+      "dead_letter_queue.max_bytes",
+      "metric.collect",
+      "pipeline.java_execution",
+      "pipeline.plugin_classloaders",
+      "path.config",
+      "path.dead_letter_queue",
+      "path.queue",
+      "pipeline.batch.delay",
+      "pipeline.batch.size",
+      "pipeline.id",
+      "pipeline.reloadable",
+      "pipeline.system",
+      "pipeline.workers",
+      "queue.checkpoint.acks",
+      "queue.checkpoint.interval",
+      "queue.checkpoint.writes",
+      "queue.checkpoint.retry",
+      "queue.drain",
+      "queue.max_bytes",
+      "queue.max_events",
+      "queue.page_capacity",
+      "queue.type",
+    ]
+
+
     def initialize
       @settings = {}
       # Theses settings were loaded from the yaml file
@@ -89,6 +122,15 @@ def merge(hash, graceful = false)
       self
     end
 
+    def merge_pipeline_settings(hash, graceful = false)
+      hash.each do |key, _|
+        unless PIPELINE_SETTINGS_WHITE_LIST.include?(key)
+          raise ArgumentError.new("Only pipeline related settings are expected. Received \"#{key}\". Allowed settings: #{PIPELINE_SETTINGS_WHITE_LIST}")
+        end
+      end
+      merge(hash, graceful)
+    end
+
     def format_settings
       output = []
       output << "-------- Logstash Settings (* means modified) ---------"