Header warning logging refactoring

client/rest/src/test/java/org/elasticsearch/client/RestClientSingleHostTests.java

@@ -519,7 +519,7 @@ private void assertDeprecationWarnings(List<String> warningHeaderTexts, List<Str
     }
 
     /**
-     * Emulates Elasticsearch's DeprecationLogger.formatWarning in simple
+     * Emulates Elasticsearch's HeaderWarningLogger.formatWarning in simple
      * cases. We don't have that available because we're testing against 1.7.
      */
     private static String formatWarningWithoutDate(String warningBody) {

distribution/src/config/log4j2.properties

@@ -77,6 +77,26 @@ logger.deprecation.level = warn
 logger.deprecation.appenderRef.deprecation_rolling.ref = deprecation_rolling
 logger.deprecation.additivity = false
 
+######## Compatible JSON #######################
+appender.compatible_rolling.type = RollingFile
+appender.compatible_rolling.name = compatible_rolling
+appender.compatible_rolling.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_compatible.json
+appender.compatible_rolling.layout.type = ECSJsonLayout
+appender.compatible_rolling.layout.type_name = compatible
+
+appender.compatible_rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_compatible-%i.json.gz
+appender.compatible_rolling.policies.type = Policies
+appender.compatible_rolling.policies.size.type = SizeBasedTriggeringPolicy
+appender.compatible_rolling.policies.size.size = 1GB
+appender.compatible_rolling.strategy.type = DefaultRolloverStrategy
+appender.compatible_rolling.strategy.max = 4
+#################################################
+
+logger.compatible.name = org.elasticsearch.compatible
+logger.compatible.level = warn
+logger.compatible.appenderRef.deprecation_rolling.ref = compatible_rolling
+logger.compatible.additivity = false
+
 ######## Search slowlog JSON ####################
 appender.index_search_slowlog_rolling.type = RollingFile
 appender.index_search_slowlog_rolling.name = index_search_slowlog_rolling

qa/evil-tests/src/test/java/org/elasticsearch/common/logging/EvilLoggerTests.java

@@ -67,6 +67,7 @@ public class EvilLoggerTests extends ESTestCase {
 
     @Override
     public void setUp() throws Exception {
+        assert "false".equals(System.getProperty("tests.security.manager")) : "-Dtests.security.manager=false has to be set";
         super.setUp();
         LogConfigurator.registerErrorListener();
     }
@@ -137,12 +138,12 @@ public void testConcurrentDeprecationLogger() throws IOException, UserException,
                  */
                 final List<String> warnings = threadContext.getResponseHeaders().get("Warning");
                 final Set<String> actualWarningValues =
-                        warnings.stream().map(s -> DeprecationLogger.extractWarningValueFromWarningHeader(s, true))
+                        warnings.stream().map(s -> HeaderWarningLogger.extractWarningValueFromWarningHeader(s, true))
                             .collect(Collectors.toSet());
                 for (int j = 0; j < 128; j++) {
                     assertThat(
                             actualWarningValues,
-                            hasItem(DeprecationLogger.escapeAndEncode("This is a maybe logged deprecation message" + j)));
+                            hasItem(HeaderWarningLogger.escapeAndEncode("This is a maybe logged deprecation message" + j)));
                 }
 
                 try {
@@ -180,7 +181,7 @@ public void testConcurrentDeprecationLogger() throws IOException, UserException,
             assertLogLine(
                     deprecationEvents.get(i),
                     Level.WARN,
-                    "org.elasticsearch.common.logging.DeprecationLogger\\$2\\.run",
+                    "org.elasticsearch.common.logging.ThrottlingLogger\\$2\\.run",
                     "This is a maybe logged deprecation message" + i);
         }
 
@@ -222,13 +223,13 @@ public void testDeprecationLoggerMaybeLog() throws IOException, UserException {
         assertLogLine(
                 deprecationEvents.get(0),
                 Level.WARN,
-                "org.elasticsearch.common.logging.DeprecationLogger\\$2\\.run",
+                "org.elasticsearch.common.logging.ThrottlingLogger\\$2\\.run",
                 "This is a maybe logged deprecation message");
         for (int k = 0; k < 128; k++) {
             assertLogLine(
                     deprecationEvents.get(1 + k),
                     Level.WARN,
-                    "org.elasticsearch.common.logging.DeprecationLogger\\$2\\.run",
+                    "org.elasticsearch.common.logging.ThrottlingLogger\\$2\\.run",
                     "This is a maybe logged deprecation message" + k);
         }
     }
@@ -256,7 +257,7 @@ public void testDeprecatedSettings() throws IOException, UserException {
             assertLogLine(
                     deprecationEvents.get(0),
                     Level.WARN,
-                    "org.elasticsearch.common.logging.DeprecationLogger\\$2\\.run",
+                    "org.elasticsearch.common.logging.ThrottlingLogger\\$2\\.run",
                     "\\[deprecated.foo\\] setting was deprecated in Elasticsearch and will be removed in a future release! " +
                             "See the breaking changes documentation for the next major version.");
         }

qa/smoke-test-http/src/test/java/org/elasticsearch/http/DeprecationHttpIT.java

@@ -25,7 +25,7 @@
 import org.elasticsearch.client.Request;
 import org.elasticsearch.client.Response;
 import org.elasticsearch.common.Strings;
-import org.elasticsearch.common.logging.DeprecationLogger;
+import org.elasticsearch.common.logging.HeaderWarningLogger;
 import org.elasticsearch.common.logging.LoggerMessageFormat;
 import org.elasticsearch.common.settings.Setting;
 import org.elasticsearch.common.settings.Settings;
@@ -42,7 +42,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import static org.elasticsearch.common.logging.DeprecationLogger.WARNING_HEADER_PATTERN;
 import static org.elasticsearch.http.TestDeprecationHeaderRestAction.TEST_DEPRECATED_SETTING_TRUE1;
 import static org.elasticsearch.http.TestDeprecationHeaderRestAction.TEST_DEPRECATED_SETTING_TRUE2;
 import static org.elasticsearch.http.TestDeprecationHeaderRestAction.TEST_NOT_DEPRECATED_SETTING;
@@ -184,10 +183,10 @@ private void doTestDeprecationWarningsAppearInHeaders() throws IOException {
 
         assertThat(deprecatedWarnings, hasSize(headerMatchers.size()));
         for (final String deprecatedWarning : deprecatedWarnings) {
-            assertThat(deprecatedWarning, matches(WARNING_HEADER_PATTERN.pattern()));
+            assertThat(deprecatedWarning, matches(HeaderWarningLogger.WARNING_HEADER_PATTERN.pattern()));
         }
         final List<String> actualWarningValues =
-                deprecatedWarnings.stream().map(s -> DeprecationLogger.extractWarningValueFromWarningHeader(s, true))
+                deprecatedWarnings.stream().map(s -> HeaderWarningLogger.extractWarningValueFromWarningHeader(s, true))
                     .collect(Collectors.toList());
         for (Matcher<String> headerMatcher : headerMatchers) {
             assertThat(actualWarningValues, hasItem(headerMatcher));

server/src/main/java/org/elasticsearch/cluster/metadata/MetadataIndexTemplateService.java

@@ -40,7 +40,7 @@
 import org.elasticsearch.common.ValidationException;
 import org.elasticsearch.common.compress.CompressedXContent;
 import org.elasticsearch.common.inject.Inject;
-import org.elasticsearch.common.logging.DeprecationLogger;
+import org.elasticsearch.common.logging.ThrottlingAndHeaderWarningLogger;
 import org.elasticsearch.common.regex.Regex;
 import org.elasticsearch.common.settings.IndexScopedSettings;
 import org.elasticsearch.common.settings.Settings;
@@ -78,8 +78,8 @@
 public class MetadataIndexTemplateService {
 
     private static final Logger logger = LogManager.getLogger(MetadataIndexTemplateService.class);
-    private static final DeprecationLogger deprecationLogger = new DeprecationLogger(logger);
-
+//    private static final DeprecationLogger deprecationLogger = new DeprecationLogger(logger);
+    private static final ThrottlingAndHeaderWarningLogger deprecationLogger = new ThrottlingAndHeaderWarningLogger(logger.getName());
     private final ClusterService clusterService;
     private final AliasValidator aliasValidator;
     private final IndicesService indicesService;
@@ -367,7 +367,7 @@ public ClusterState addIndexTemplateV2(final ClusterState currentState, final bo
                     .collect(Collectors.joining(",")),
                 name);
             logger.warn(warning);
-            deprecationLogger.deprecatedAndMaybeLog("index_template_pattern_overlap", warning);
+            deprecationLogger.headerWarnAndThrottleLog("index_template_pattern_overlap", warning);
         }
 
         IndexTemplateV2 finalIndexTemplate = template;
@@ -601,7 +601,7 @@ static ClusterState innerPutTemplate(final ClusterState currentState, PutRequest
                         .collect(Collectors.joining(",")),
                     request.name);
                 logger.warn(warning);
-                deprecationLogger.deprecatedAndMaybeLog("index_template_pattern_overlap", warning);
+                deprecationLogger.headerWarnAndThrottleLog("index_template_pattern_overlap", warning);
             } else {
                 // Otherwise, this is a hard error, the user should use V2 index templates instead
                 String error = String.format(Locale.ROOT, "template [%s] has index patterns %s matching patterns" +

server/src/main/java/org/elasticsearch/common/logging/CompatibleApiLogger.java

@@ -0,0 +1,42 @@
+/*
+ * Licensed to Elasticsearch under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.elasticsearch.common.logging;
+
+import org.apache.logging.log4j.Logger;
+
+/**
+ * A logger that logs compatible API notices.
+ */
+public class CompatibleApiLogger extends ThrottlingAndHeaderWarningLogger{
+
+    public CompatibleApiLogger(Logger parentLogger) {
+        super(compatibleApiLogger(parentLogger));
+    }
+
+    private static String compatibleApiLogger(Logger parentLogger) {
+        String name = parentLogger.getName();
+        if (name.startsWith("org.elasticsearch")) {
+            name = name.replace("org.elasticsearch.", "org.elasticsearch.compatible.");
+        } else {
+            name = "compatible." + name;
+        }
+        return name;
+    }
+}