[browser logging] allow to configure root level (elastic#176397)

## Summary Part of elastic#144276 - Introduce the concept of browser-side logging configuration, via a `logging.browser` config prefix - Allow to configure the log level for the root browser logger via `logging.browser.root.level` - Set the default level to `info` for both dev and production mode (consistent with server-side logging) --------- Co-authored-by: kibanamachine <[email protected]>
leemthompo · Feb 12, 2024 · 1dc0076 · 1dc0076
1 parent 46c10ec
commit 1dc0076
Show file tree

Hide file tree

Showing 20 changed files with 174 additions and 44 deletions.
diff --git a/config/kibana.yml b/config/kibana.yml
@@ -133,6 +133,10 @@
 #  - name: metrics.ops
 #    level: debug
 
+# Enables debug logging on the browser (dev console)
+#logging.browser.root:
+#  level: debug
+
 # =================== System: Other ===================
 # The path where Kibana stores persistent data not saved in Elasticsearch. Defaults to data
 #path.data: data

diff --git a/packages/analytics/client/src/analytics_client/analytics_client.ts b/packages/analytics/client/src/analytics_client/analytics_client.ts
@@ -133,12 +133,9 @@ export class AnalyticsClient implements IAnalyticsClient {
       properties: eventData as unknown as Record<string, unknown>,
     };
 
-    // debug-logging before checking the opt-in status to help during development
-    if (this.initContext.isDev) {
-      this.initContext.logger.debug<EventDebugLogMeta>(`Report event "${eventType}"`, {
-        ebt_event: event,
-      });
-    }
+    this.initContext.logger.debug<EventDebugLogMeta>(`Report event "${eventType}"`, {
+      ebt_event: event,
+    });
 
     const optInConfig = this.optInConfig$.value;
 

diff --git a/packages/core/injected-metadata/core-injected-metadata-common-internal/src/types.ts b/packages/core/injected-metadata/core-injected-metadata-common-internal/src/types.ts
@@ -10,6 +10,7 @@ import type { PluginName, DiscoveredPlugin } from '@kbn/core-base-common';
 import type { ThemeVersion } from '@kbn/ui-shared-deps-npm';
 import type { EnvironmentMode, PackageInfo } from '@kbn/config';
 import type { CustomBranding } from '@kbn/core-custom-branding-common';
+import type { BrowserLoggingConfig } from '@kbn/core-logging-common-internal';
 
 /** @internal */
 export interface InjectedMetadataClusterInfo {
@@ -45,6 +46,7 @@ export interface InjectedMetadata {
   publicBaseUrl?: string;
   assetsHrefBase: string;
   clusterInfo: InjectedMetadataClusterInfo;
+  logging: BrowserLoggingConfig;
   env: {
     mode: EnvironmentMode;
     packageInfo: PackageInfo;

diff --git a/packages/core/injected-metadata/core-injected-metadata-common-internal/tsconfig.json b/packages/core/injected-metadata/core-injected-metadata-common-internal/tsconfig.json
@@ -15,7 +15,8 @@
     "@kbn/config",
     "@kbn/ui-shared-deps-npm",
     "@kbn/core-base-common",
-    "@kbn/core-custom-branding-common"
+    "@kbn/core-custom-branding-common",
+    "@kbn/core-logging-common-internal"
   ],
   "exclude": [
     "target/**/*",

diff --git a/packages/core/logging/core-logging-browser-internal/src/logging_system.test.ts b/packages/core/logging/core-logging-browser-internal/src/logging_system.test.ts
@@ -6,19 +6,29 @@
  * Side Public License, v 1.
  */
 
+import type { BrowserLoggingConfig } from '@kbn/core-logging-common-internal';
 import { unsafeConsole } from '@kbn/security-hardening';
 import { BrowserLoggingSystem } from './logging_system';
 
-describe('', () => {
+describe('BrowserLoggingSystem', () => {
   const timestamp = new Date(Date.UTC(2012, 1, 1, 14, 33, 22, 11));
 
   let mockConsoleLog: jest.SpyInstance;
   let loggingSystem: BrowserLoggingSystem;
 
+  const createLoggingConfig = (parts: Partial<BrowserLoggingConfig> = {}): BrowserLoggingConfig => {
+    return {
+      root: {
+        level: 'warn',
+      },
+      ...parts,
+    };
+  };
+
   beforeEach(() => {
     mockConsoleLog = jest.spyOn(unsafeConsole, 'log').mockReturnValue(undefined);
     jest.spyOn<any, any>(global, 'Date').mockImplementation(() => timestamp);
-    loggingSystem = new BrowserLoggingSystem({ logLevel: 'warn' });
+    loggingSystem = new BrowserLoggingSystem(createLoggingConfig());
   });
 
   afterEach(() => {
@@ -74,5 +84,37 @@ describe('', () => {
         ]
       `);
     });
+
+    it('allows to override the root logger level', () => {
+      loggingSystem = new BrowserLoggingSystem(createLoggingConfig({ root: { level: 'debug' } }));
+
+      const logger = loggingSystem.get('foo.bar');
+      logger.trace('some trace message');
+      logger.debug('some debug message');
+      logger.info('some info message');
+      logger.warn('some warn message');
+      logger.error('some error message');
+      logger.fatal('some fatal message');
+
+      expect(mockConsoleLog.mock.calls).toMatchInlineSnapshot(`
+        Array [
+          Array [
+            "[2012-01-31T13:33:22.011-05:00][DEBUG][foo.bar] some debug message",
+          ],
+          Array [
+            "[2012-01-31T08:33:22.011-05:00][INFO ][foo.bar] some info message",
+          ],
+          Array [
+            "[2012-01-31T03:33:22.011-05:00][WARN ][foo.bar] some warn message",
+          ],
+          Array [
+            "[2012-01-30T22:33:22.011-05:00][ERROR][foo.bar] some error message",
+          ],
+          Array [
+            "[2012-01-30T17:33:22.011-05:00][FATAL][foo.bar] some fatal message",
+          ],
+        ]
+      `);
+    });
   });
 });
diff --git a/packages/core/logging/core-logging-browser-internal/src/logging_system.ts b/packages/core/logging/core-logging-browser-internal/src/logging_system.ts
@@ -6,17 +6,13 @@
  * Side Public License, v 1.
  */
 
-import { LogLevel, Logger, LoggerFactory, LogLevelId, DisposableAppender } from '@kbn/logging';
-import { getLoggerContext } from '@kbn/core-logging-common-internal';
+import { LogLevel, Logger, LoggerFactory, DisposableAppender } from '@kbn/logging';
+import { getLoggerContext, BrowserLoggingConfig } from '@kbn/core-logging-common-internal';
 import type { LoggerConfigType } from './types';
 import { BaseLogger } from './logger';
 import { PatternLayout } from './layouts';
 import { ConsoleAppender } from './appenders';
 
-export interface BrowserLoggingConfig {
-  logLevel: LogLevelId;
-}
-
 const CONSOLE_APPENDER_ID = 'console';
 
 /**
@@ -54,7 +50,7 @@ export class BrowserLoggingSystem implements IBrowserLoggingSystem {
 
   private getLoggerConfigByContext(context: string): LoggerConfigType {
     return {
-      level: this.loggingConfig.logLevel,
+      level: this.loggingConfig.root.level,
       appenders: [CONSOLE_APPENDER_ID],
       name: context,
     };

diff --git a/packages/core/logging/core-logging-common-internal/index.ts b/packages/core/logging/core-logging-common-internal/index.ts
@@ -22,3 +22,4 @@ export {
   ROOT_CONTEXT_NAME,
   DEFAULT_APPENDER_NAME,
 } from './src';
+export type { BrowserLoggingConfig, BrowserRootLoggerConfig } from './src/browser_config';
diff --git a/packages/core/logging/core-logging-common-internal/src/browser_config.ts b/packages/core/logging/core-logging-common-internal/src/browser_config.ts
@@ -0,0 +1,23 @@
+/*
+ * 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 type { LogLevelId } from '@kbn/logging';
+
+/**
+ * @internal
+ */
+export interface BrowserLoggingConfig {
+  root: BrowserRootLoggerConfig;
+}
+
+/**
+ * @internal
+ */
+export interface BrowserRootLoggerConfig {
+  level: LogLevelId;
+}
diff --git a/packages/core/logging/core-logging-server-internal/index.ts b/packages/core/logging/core-logging-server-internal/index.ts
@@ -9,6 +9,7 @@
 export { config } from './src/logging_config';
 export type {
   LoggingConfigType,
+  LoggingConfigWithBrowserType,
   loggerContextConfigSchema,
   loggerSchema,
 } from './src/logging_config';

diff --git a/packages/core/logging/core-logging-server-internal/src/logging_config.test.ts b/packages/core/logging/core-logging-server-internal/src/logging_config.test.ts
@@ -12,6 +12,11 @@ test('`schema` creates correct schema with defaults.', () => {
   expect(config.schema.validate({})).toMatchInlineSnapshot(`
     Object {
       "appenders": Map {},
+      "browser": Object {
+        "root": Object {
+          "level": "info",
+        },
+      },
       "loggers": Array [],
       "root": Object {
         "appenders": Array [

diff --git a/packages/core/logging/core-logging-server-internal/src/logging_config.ts b/packages/core/logging/core-logging-server-internal/src/logging_config.ts
@@ -47,6 +47,12 @@ export const loggerSchema = schema.object({
   level: levelSchema,
 });
 
+const browserConfig = schema.object({
+  root: schema.object({
+    level: levelSchema,
+  }),
+});
+
 export const config = {
   path: 'logging',
   schema: schema.object({
@@ -63,6 +69,7 @@ export const config = {
       }),
       level: levelSchema,
     }),
+    browser: browserConfig,
   }),
 };
 
@@ -71,6 +78,10 @@ export type LoggingConfigType = Pick<TypeOf<typeof config.schema>, 'loggers' | '
   appenders: Map<string, AppenderConfigType>;
 };
 
+/** @internal */
+export type LoggingConfigWithBrowserType = LoggingConfigType &
+  Pick<TypeOf<typeof config.schema>, 'browser'>;
+
 /**
  * Config schema for validating the inputs to the {@link LoggingServiceStart.configure} API.
  * See {@link LoggerContextConfigType}.

diff --git a/...rendering/core-rendering-server-internal/src/__snapshots__/rendering_service.test.ts.snap b/...rendering/core-rendering-server-internal/src/__snapshots__/rendering_service.test.ts.snap
diff --git a/packages/core/rendering/core-rendering-server-internal/src/render_utils.ts b/packages/core/rendering/core-rendering-server-internal/src/render_utils.ts
@@ -6,9 +6,16 @@
  * Side Public License, v 1.
  */
 
+import { firstValueFrom } from 'rxjs';
 import UiSharedDepsNpm from '@kbn/ui-shared-deps-npm';
 import * as UiSharedDepsSrc from '@kbn/ui-shared-deps-src';
+import type { IConfigService } from '@kbn/config';
+import type { BrowserLoggingConfig } from '@kbn/core-logging-common-internal';
 import type { UiSettingsParams, UserProvidedValues } from '@kbn/core-ui-settings-common';
+import {
+  config as loggingConfigDef,
+  type LoggingConfigWithBrowserType,
+} from '@kbn/core-logging-server-internal';
 
 export const getSettingValue = <T>(
   settingName: string,
@@ -54,3 +61,12 @@ export const getStylesheetPaths = ({
         ]),
   ];
 };
+
+export const getBrowserLoggingConfig = async (
+  configService: IConfigService
+): Promise<BrowserLoggingConfig> => {
+  const loggingConfig = await firstValueFrom(
+    configService.atPath<LoggingConfigWithBrowserType>(loggingConfigDef.path)
+  );
+  return loggingConfig.browser;
+};