Renamed 'allow.legacy.monitoring' to 'xpack.monitoring.allow_legacy_collection' and moved the registering of such setting from core to xpack

Author: andsel

config/logstash.yml

@@ -334,14 +334,12 @@
 # Default to direct, optionally can be switched to heap to select Java heap space.
 # pipeline.buffer.type: direct
 #
-#
-# Flag to allow the legacy internal monitoring (default: false)
-# allow.legacy.monitoring: false
-#
 # ------------ X-Pack Settings (not applicable for OSS build)--------------
 #
 # X-Pack Monitoring
 # https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html
+# Flag to allow the legacy internal monitoring (default: false)
+#xpack.monitoring.allow_legacy_collection: false
 #xpack.monitoring.enabled: false
 #xpack.monitoring.elasticsearch.username: logstash_system
 #xpack.monitoring.elasticsearch.password: password

docker/data/logstash/env2yaml/env2yaml.go

@@ -17,7 +17,6 @@ package main
 import (
 	"errors"
 	"fmt"
-	"gopkg.in/yaml.v2"
 	"io/ioutil"
 	"log"
 	"os"
@@ -86,7 +85,7 @@ var validSettings = []string{
 	"api.auth.basic.password_policy.include.symbol",
 	"allow_superuser",
 	"monitoring.cluster_uuid",
-	"allow.legacy.monitoring",
+	"xpack.monitoring.allow_legacy_collection",
 	"xpack.monitoring.enabled",
 	"xpack.monitoring.collection.interval",
 	"xpack.monitoring.elasticsearch.hosts",

logstash-core/lib/logstash/api/commands/default_metadata.rb

@@ -71,7 +71,8 @@ def http_address
 
         private
         def enabled_xpack_monitoring?
-          LogStash::SETTINGS.get_value("allow.legacy.monitoring") &&
+          LogStash::SETTINGS.registered?("xpack.monitoring.allow_legacy_collection") &&
+          LogStash::SETTINGS.get_value("xpack.monitoring.allow_legacy_collection") &&
           LogStash::SETTINGS.registered?("xpack.monitoring.enabled") &&
           LogStash::SETTINGS.get("xpack.monitoring.enabled")
         end

logstash-core/lib/logstash/environment.rb

@@ -110,8 +110,7 @@ module Environment
             Setting::String.new("keystore.classname", "org.logstash.secret.store.backend.JavaKeyStore"),
             Setting::String.new("keystore.file", ::File.join(::File.join(LogStash::Environment::LOGSTASH_HOME, "config"), "logstash.keystore"), false), # will be populated on
     Setting::NullableString.new("monitoring.cluster_uuid"),
-            Setting::String.new("pipeline.buffer.type", "direct", true, ["direct", "heap"]),
-           Setting::Boolean.new("allow.legacy.monitoring", false)
+            Setting::String.new("pipeline.buffer.type", "direct", true, ["direct", "heap"])
   # post_process
   ].each {|setting| SETTINGS.register(setting) }
 

logstash-core/lib/logstash/settings.rb

@@ -91,6 +91,10 @@ def register(setting)
       # return a List, so the following type checking before going deep by one layer.
       return setting.map { |s| register(s) } if setting.kind_of?(Array) || setting.kind_of?(java.util.List)
 
+      # if setting.name == "xpack.monitoring.allow_legacy_collection"
+      #   puts ">>> call stack Compiler#compile_sources"; caller.each { |frame| puts "#{frame}"}
+      # end
+
       if @settings.key?(setting.name)
         raise ArgumentError.new("Setting \"#{setting.name}\" has already been registered as #{setting.inspect}")
       else

logstash-core/spec/logstash/api/commands/default_metadata_spec.rb

@@ -55,15 +55,15 @@ def registerIfNot(setting)
     end
 
     it "check monitoring section exist when legacy monitoring is enabled and allowed" do
-      LogStash::SETTINGS.set_value("allow.legacy.monitoring", true)
+      LogStash::SETTINGS.set_value("xpack.monitoring.allow_legacy_collection", true)
       LogStash::SETTINGS.set_value("xpack.monitoring.enabled", true)
       expect(report.keys).to include(
         :monitoring
         )
     end
 
     it "check monitoring section does not appear when legacy monitoring is not allowed but enabled" do
-      LogStash::SETTINGS.set_value("allow.legacy.monitoring", false)
+      LogStash::SETTINGS.set_value("xpack.monitoring.allow_legacy_collection", false)
       LogStash::SETTINGS.set_value("xpack.monitoring.enabled", true)
       expect(report.keys).not_to include(
                                :monitoring

logstash-core/src/main/java/org/logstash/JavaClassWithInitialize.java

@@ -0,0 +1,48 @@
+package org.logstash;
+
+import org.apache.logging.log4j.core.AbstractLifeCycle;
+import org.apache.logging.log4j.core.Filter;
+import org.apache.logging.log4j.core.Layout;
+import org.apache.logging.log4j.core.config.Property;
+import org.apache.logging.log4j.core.filter.AbstractFilterable;
+
+import java.io.Serializable;
+
+public class JavaClassWithInitialize
+//        extends AbstractLifeCycle
+        extends AbstractFilterable
+{
+    private String name;
+
+//    protected JavaClassWithInitialize(String name) {
+//        this.name = name;
+//    }
+//
+//    protected JavaClassWithInitialize(String name, String surname) {
+//        this.name = name + surname;
+//    }
+//
+//    protected JavaClassWithInitialize(String name, String surname, boolean collapse) {
+//        this.name = name + surname;
+//    }
+
+//    @Deprecated
+    protected JavaClassWithInitialize(final String name, final Filter filter, final Layout<? extends Serializable> layout) {
+        this(name, filter, layout, true, Property.EMPTY_ARRAY);
+    }
+
+//    /** @deprecated */
+//    @Deprecated
+//    protected JavaClassWithInitialize(final String name, final Filter filter, final Layout<? extends Serializable> layout, final boolean ignoreExceptions) {
+//        this(name, filter, layout, ignoreExceptions, Property.EMPTY_ARRAY);
+//    }
+
+    protected JavaClassWithInitialize(final String name, final Filter filter, final Layout<? extends Serializable> layout, final boolean ignoreExceptions, final Property[] properties) {
+        this.name = name;
+    }
+
+    @Override
+    public void initialize() {
+        this.name = "Name added";
+    }
+}

x-pack/lib/monitoring/monitoring.rb

@@ -155,10 +155,13 @@ def after_agent(runner)
       # For versions prior to 6.3 the default value of "xpack.monitoring.enabled" was true
       # For versions 6.3+ the default of "xpack.monitoring.enabled" is false.
       # To help keep passivity, assume that if "xpack.monitoring.elasticsearch.hosts" has been set that monitoring should be enabled.
-      # return true if allow.legacy.monitoring=true and xpack.monitoring.enabled=true (explicitly) or xpack.monitoring.elasticsearch.hosts is configured
+      # return true if xpack.monitoring.allow_legacy_collection=true and xpack.monitoring.enabled=true (explicitly) or xpack.monitoring.elasticsearch.hosts is configured
       def monitoring_enabled?(settings)
         log_warn_if_legacy_is_enabled_and_not_allowed(settings)
-        return false unless settings.get_value("allow.legacy.monitoring")
+        # LogStash::SETTINGS.registered?("xpack.monitoring.allow_legacy_collection") &&
+        #   +          LogStash::SETTINGS.get_value("xpack.monitoring.allow_legacy_collection")
+        # return false if LogStash::SETTINGS.registered?("xpack.monitoring.allow_legacy_collection") && !settings.get_value("xpack.monitoring.allow_legacy_collection")
+        return false unless settings.get_value("xpack.monitoring.allow_legacy_collection")
         return settings.get_value("monitoring.enabled") if settings.set?("monitoring.enabled")
         return settings.get_value("xpack.monitoring.enabled") if settings.set?("xpack.monitoring.enabled")
 
@@ -173,10 +176,10 @@ def monitoring_enabled?(settings)
       end
 
       def log_warn_if_legacy_is_enabled_and_not_allowed(settings)
-        allowed = settings.get_value("allow.legacy.monitoring")
+        allowed = settings.get_value("xpack.monitoring.allow_legacy_collection")
         legacy_monitoring_enabled = (settings.get_value("xpack.monitoring.enabled") || settings.get_value("monitoring.enabled"))
         if !allowed && legacy_monitoring_enabled
-          logger.warn("You have enabled legacy internal monitoring. However, starting from version 9.0, this feature is deactivated and behind a feature flag. Set `allow.legacy.monitoring` to `true` to allow access to the feature.")
+          logger.warn("You have enabled legacy internal monitoring. However, starting from version 9.0, this feature is deactivated and behind a feature flag. Set `xpack.monitoring.allow_legacy_collection` to `true` to allow access to the feature.")
         end
       end
       private :log_warn_if_legacy_is_enabled_and_not_allowed
@@ -270,6 +273,9 @@ def additionals_settings(settings)
 
     private
     def register_monitoring_settings(settings, prefix = "")
+      if prefix == "xpack."
+        settings.register(LogStash::Setting::Boolean.new("xpack.monitoring.allow_legacy_collection", false))
+      end
       settings.register(LogStash::Setting::Boolean.new("#{prefix}monitoring.enabled", false))
       settings.register(LogStash::Setting::ArrayCoercible.new("#{prefix}monitoring.elasticsearch.hosts", String, ["http://localhost:9200"]))
       settings.register(LogStash::Setting::TimeValue.new("#{prefix}monitoring.collection.interval", "10s"))

x-pack/qa/integration/management/multiple_pipelines_spec.rb

@@ -33,7 +33,7 @@
         "xpack.management.elasticsearch.hosts" => ["http://localhost:9200"],
         "xpack.management.elasticsearch.username" => "elastic",
         "xpack.management.elasticsearch.password" => elastic_password,
-        "allow.legacy.monitoring" => true,
+        "xpack.monitoring.allow_legacy_collection" => true,
         "xpack.monitoring.elasticsearch.username" => "elastic",
         "xpack.monitoring.elasticsearch.password" => elastic_password
 

x-pack/qa/integration/monitoring/direct_shipping_spec.rb

@@ -15,7 +15,7 @@
 
     @logstash_service = logstash_with_empty_default("bin/logstash -e '#{config}' -w 1  --pipeline.id #{SecureRandom.hex(8)}", {
       :settings => {
-        "allow.legacy.monitoring" => true,
+        "xpack.monitoring.allow_legacy_collection" => true,
         "monitoring.enabled" => true,
         "monitoring.elasticsearch.hosts" => ["http://localhost:9200", "http://localhost:9200"],
         "monitoring.collection.interval" => "1s",