[7.17] [json layout] use json representation of meta when available (#171310) (#171346)

# Backport This will backport the following commits from `main` to `7.17`: - [[json layout] use json representation of `meta` when available (#171310)](https://github.com/elastic/kibana/pull/171310)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)
2025-04-24 09:48:58 -04:00 · 2023-11-15 23:01:44 +01:00 · 2023-11-15 23:01:44 +01:00 · 3f5c10e9da
commit 3f5c10e9da
parent a28849a83e
3 changed files with 185 additions and 1 deletions
--- a/src/core/server/elasticsearch/integration_tests/error_logging.test.ts
+++ b/src/core/server/elasticsearch/integration_tests/error_logging.test.ts
@ -0,0 +1,94 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import {
+  createTestServers,
+  type TestElasticsearchUtils,
+  type TestKibanaUtils,
+} from '../../../test_helpers/kbn_server';
+
+describe('Error logging', () => {
+  describe('ES client errors', () => {
+    let mockConsoleLog: jest.SpyInstance;
+    let esServer: TestElasticsearchUtils;
+    let kibanaServer: TestKibanaUtils;
+
+    beforeAll(async () => {
+      mockConsoleLog = jest.spyOn(global.console, 'log');
+
+      const { startES, startKibana } = createTestServers({
+        adjustTimeout: jest.setTimeout,
+        settings: {
+          kbn: {
+            logging: {
+              appenders: {
+                'console-json': {
+                  type: 'console',
+                  layout: {
+                    type: 'json',
+                  },
+                },
+              },
+              loggers: [{ name: 'console-json', appenders: ['console-json'], level: 'debug' }],
+            },
+          },
+        },
+      });
+
+      esServer = await startES();
+      kibanaServer = await startKibana();
+    });
+
+    beforeEach(() => {
+      mockConsoleLog.mockClear();
+    });
+
+    afterAll(async () => {
+      mockConsoleLog.mockRestore();
+      await kibanaServer.stop();
+      await esServer.stop();
+    });
+
+    it('logs errors following the expected pattern for the json layout', async () => {
+      const esClient = kibanaServer.coreStart.elasticsearch.client.asInternalUser;
+      const logger = kibanaServer.root.logger.get('console-json');
+
+      try {
+        await esClient.search({
+          index: '.kibana',
+          // @ts-expect-error yes this is invalid
+          query: { someInvalidQuery: { foo: 'bar' } },
+        });
+        expect('should have thrown').toEqual('but it did not');
+      } catch (e) {
+        logger.info('logging elasticsearch error', e);
+
+        const calls = mockConsoleLog.mock.calls;
+        const ourCall = calls
+          .map((call) => call[0])
+          .find((call) => call.includes('logging elasticsearch error'));
+
+        expect(JSON.parse(ourCall)).toEqual({
+          '@timestamp': expect.any(String),
+          ecs: {
+            version: expect.any(String),
+          },
+          log: {
+            level: 'INFO',
+            logger: 'console-json',
+          },
+          message: 'logging elasticsearch error',
+          name: 'ResponseError',
+          process: {
+            pid: expect.any(Number),
+          },
+        });
+      }
+    });
+  });
+});
--- a/src/core/server/logging/layouts/json_layout.test.ts
+++ b/src/core/server/logging/layouts/json_layout.test.ts
@ -308,3 +308,88 @@ test('format() meta can not override timestamp', () => {
    },
  });
 });
+
+test('format() meta.toJSON() is used if own property', () => {
+  const layout = new JsonLayout();
+  expect(
+    JSON.parse(
+      layout.format({
+        message: 'foo',
+        timestamp,
+        level: LogLevel.Debug,
+        context: 'bar',
+        pid: 3,
+        meta: {
+          server: {
+            address: 'localhost',
+          },
+          service: {
+            version: '1',
+          },
+          toJSON() {
+            return {
+              server: {
+                address: 'localhost',
+              },
+            };
+          },
+        },
+      })
+    )
+  ).toStrictEqual({
+    ecs: { version: expect.any(String) },
+    '@timestamp': '2012-02-01T09:30:22.011-05:00',
+    message: 'foo',
+    log: {
+      level: 'DEBUG',
+      logger: 'bar',
+    },
+    process: {
+      pid: 3,
+    },
+    server: {
+      address: 'localhost',
+    },
+  });
+});
+
+test('format() meta.toJSON() is used if present on prototype', () => {
+  class SomeClass {
+    foo: string = 'bar';
+    hello: string = 'dolly';
+
+    toJSON() {
+      return {
+        foo: this.foo,
+      };
+    }
+  }
+
+  const someInstance = new SomeClass();
+
+  const layout = new JsonLayout();
+  expect(
+    JSON.parse(
+      layout.format({
+        message: 'foo',
+        timestamp,
+        level: LogLevel.Debug,
+        context: 'bar',
+        pid: 3,
+        meta: someInstance,
+      })
+    )
+  ).toStrictEqual({
+    ecs: { version: expect.any(String) },
+    '@timestamp': '2012-02-01T09:30:22.011-05:00',
+    message: 'foo',
+    log: {
+      level: 'DEBUG',
+      logger: 'bar',
+    },
+    process: {
+      pid: 3,
+    },
+    foo: 'bar',
+  });
+});
--- a/src/core/server/logging/layouts/json_layout.ts
+++ b/src/core/server/logging/layouts/json_layout.ts
@ -55,7 +55,12 @@ export class JsonLayout implements Layout {
        pid: record.pid,
      },
    };
-    const output = record.meta ? merge({ ...record.meta }, log) : log;
+
+    let output = log;
+    if (record.meta) {
+      const serializedMeta = record.meta.toJSON ? record.meta.toJSON() : { ...record.meta };
+      output = merge(serializedMeta, log);
+    }

    return JSON.stringify(output);
  }