Update logic to include loggers & also use default appender.

elastic · Oct 18, 2021 · e96a2a7 · e96a2a7
1 parent 9ee9b5a
commit e96a2a7
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 25 deletions.
diff --git a/src/core/server/config/deprecation/core_deprecations.test.ts b/src/core/server/config/deprecation/core_deprecations.test.ts
@@ -483,30 +483,52 @@ describe('core deprecations', () => {
   });
 
   describe('using default pattern layout', () => {
-    it('warns when console appender is used', () => {
-      const { messages } = applyCoreDeprecations({
-        logging: {
-          root: {
-            appenders: ['default', 'console', 'test'],
-          },
-        },
-      });
-      expect(messages).toMatchInlineSnapshot(`
-        Array [
-          "It looks like you are using Kibana's built-in \`console\` appender, which uses the \\"pattern\\" layout by default. In 8.0, the default layout will switch to JSON, which is ECS-compliant. If you are relying on the default pattern layout for log ingestion, be sure to explicitly configure this in your Kibana configuration to prevent any disruption when upgrading to 8.0.",
-        ]
-      `);
-    });
+    ['default', 'console'].forEach((appender) => {
+      describe(appender, () => {
+        it(`warns when ${appender} appender is used in root`, () => {
+          const { messages } = applyCoreDeprecations({
+            logging: {
+              root: {
+                appenders: [appender, 'test'],
+              },
+            },
+          });
+          expect(messages).toMatchInlineSnapshot(`
+            Array [
+              "It looks like you are using Kibana's built-in \`console\` appender, which uses the \\"pattern\\" layout by default. In 8.0, the default layout will switch to JSON, which is ECS-compliant. If you are relying on the default pattern layout for log ingestion, be sure to explicitly configure this in your Kibana configuration to prevent any disruption when upgrading to 8.0.",
+            ]
+          `);
+        });
 
-    it('does not warn when console appender is not used', () => {
-      const { messages } = applyCoreDeprecations({
-        logging: {
-          root: {
-            level: 'warn',
-          },
-        },
+        it(`warns when ${appender} appender is used in loggers`, () => {
+          const { messages } = applyCoreDeprecations({
+            logging: {
+              loggers: [
+                {
+                  name: 'my-logger',
+                  appenders: [appender],
+                },
+              ],
+            },
+          });
+          expect(messages).toMatchInlineSnapshot(`
+            Array [
+              "It looks like you are using Kibana's built-in \`console\` appender, which uses the \\"pattern\\" layout by default. In 8.0, the default layout will switch to JSON, which is ECS-compliant. If you are relying on the default pattern layout for log ingestion, be sure to explicitly configure this in your Kibana configuration to prevent any disruption when upgrading to 8.0.",
+            ]
+          `);
+        });
+
+        it(`does not warn when ${appender} appender is not used in root`, () => {
+          const { messages } = applyCoreDeprecations({
+            logging: {
+              root: {
+                level: 'warn',
+              },
+            },
+          });
+          expect(messages).toMatchInlineSnapshot(`Array []`);
+        });
       });
-      expect(messages).toMatchInlineSnapshot(`Array []`);
     });
 
     it('does not warn when console appender is overwritten', () => {
@@ -522,7 +544,7 @@ describe('core deprecations', () => {
             },
           },
           root: {
-            appenders: ['default', 'console'],
+            appenders: ['console'],
           },
         },
       });

diff --git a/src/core/server/config/deprecation/core_deprecations.ts b/src/core/server/config/deprecation/core_deprecations.ts
@@ -8,6 +8,7 @@
 
 import { i18n } from '@kbn/i18n';
 import { ConfigDeprecationProvider, ConfigDeprecation } from '@kbn/config';
+import { LoggingConfigType } from '../../logging';
 
 const kibanaPathConf: ConfigDeprecation = (settings, fromPath, addDeprecation) => {
   if (process.env?.KIBANA_PATH_CONF) {
@@ -598,9 +599,15 @@ const patternLayoutDefaultLoggingDeprecation: ConfigDeprecation = (
   addDeprecation,
   { branch }
 ) => {
+  const usesAppender = (name: string) =>
+    settings.logging?.root?.appenders?.includes(name) ||
+    settings.logging?.loggers?.some((logger: LoggingConfigType['loggers'][number]) =>
+      logger.appenders?.includes(name)
+    );
+
   if (
-    settings.logging?.root?.appenders?.includes('console') &&
-    settings.logging?.appenders?.console === undefined
+    (usesAppender('default') && settings.logging?.appenders?.default === undefined) ||
+    (usesAppender('console') && settings.logging?.appenders?.console === undefined)
   ) {
     addDeprecation({
       configPath: 'logging.root.appenders',