JSON based logger (#642)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ardatan

.changeset/@graphql-hive_gateway-runtime-642-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@graphql-hive/gateway-runtime': patch
+---
+
+dependencies updates: 
+
+- Added dependency [`@graphql-hive/logger-json@workspace:^` ↗︎](https://www.npmjs.com/package/@graphql-hive/logger-json/v/workspace:^) (to `dependencies`)

.changeset/big-waves-prove.md

@@ -0,0 +1,15 @@
+---
+'@graphql-mesh/transport-http-callback': patch
+'@graphql-mesh/plugin-opentelemetry': patch
+'@graphql-mesh/fusion-runtime': patch
+'@graphql-mesh/transport-ws': patch
+'@graphql-hive/importer': patch
+'@graphql-hive/gateway': patch
+'@graphql-hive/gateway-runtime': patch
+'@graphql-hive/logger-json': patch
+---
+
+New JSON-based logger
+
+By default, it prints pretty still to the console unless NODE_ENV is production.
+For JSON output, set the `LOG_FORMAT` environment variable to `json`.

package.json

@@ -60,6 +60,8 @@
     "vitest": "^3.0.1"
   },
   "resolutions": {
+    "@graphql-mesh/types": "0.103.16-alpha-20250212125252-6167fff12fe4017202b35363ff2769aafe28f98a",
+    "@graphql-mesh/utils": "0.103.16-alpha-20250212125252-6167fff12fe4017202b35363ff2769aafe28f98a",
     "@graphql-tools/delegate": "workspace:^",
     "@opentelemetry/exporter-trace-otlp-http": "patch:@opentelemetry/exporter-trace-otlp-http@npm%3A0.56.0#~/.yarn/patches/@opentelemetry-exporter-trace-otlp-http-npm-0.56.0-dddd282e41.patch",
     "@opentelemetry/otlp-exporter-base": "patch:@opentelemetry/otlp-exporter-base@npm%3A0.56.0#~/.yarn/patches/@opentelemetry-otlp-exporter-base-npm-0.56.0-ba3dc5f5c5.patch",

packages/fusion-runtime/src/federation/supergraph.ts

@@ -311,11 +311,13 @@ export const handleFederationSupergraph: UnifiedGraphHandler = function ({
           if (context?.request) {
             requestId = requestIdByRequest.get(context.request);
             if (requestId) {
-              currentLogger = currentLogger?.child(requestId);
+              currentLogger = currentLogger?.child({ requestId });
             }
           }
           if (sourceSubschema.name) {
-            currentLogger = currentLogger?.child(sourceSubschema.name);
+            currentLogger = currentLogger?.child({
+              subgraph: sourceSubschema.name,
+            });
           }
           for (const onDelegationPlan of onDelegationPlanHooks) {
             const onDelegationPlanDone = onDelegationPlan({

packages/fusion-runtime/src/utils.ts

@@ -102,7 +102,7 @@ function getTransportExecutor({
   let logger = transportContext?.logger;
   if (logger) {
     if (subgraphName) {
-      logger = logger.child(subgraphName);
+      logger = logger.child({ subgraph: subgraphName });
     }
     logger?.debug(`Loading transport "${kind}"`);
   }
@@ -195,10 +195,10 @@ export function getOnSubgraphExecute({
           executionRequest.context?.request,
         );
         if (requestId) {
-          logger = logger.child(requestId);
+          logger = logger.child({ requestId });
         }
         if (subgraphName) {
-          logger = logger.child(subgraphName);
+          logger = logger.child({ subgraph: subgraphName });
         }
         logger.debug(`Initializing executor`);
       }
@@ -287,7 +287,7 @@ export function wrapExecutorWithHooks({
     let execReqLogger = transportContext?.logger;
     if (execReqLogger) {
       if (requestId) {
-        execReqLogger = execReqLogger.child(requestId);
+        execReqLogger = execReqLogger.child({ requestId });
       }
       loggerForExecutionRequest.set(baseExecutionRequest, execReqLogger);
     }
@@ -548,11 +548,11 @@ export function wrapMergedTypeResolver<TContext extends Record<string, any>>(
     if (logger && context['request']) {
       requestId = requestIdByRequest.get(context['request']);
       if (requestId) {
-        logger = logger.child(requestId);
+        logger = logger.child({ requestId });
       }
     }
     if (subschema.name) {
-      logger = logger?.child(subschema.name);
+      logger = logger?.child({ subgraph: subschema.name });
     }
     let resolver = originalResolver as MergedTypeResolver<TContext>;
     function setResolver(newResolver: MergedTypeResolver<TContext>) {

packages/fusion-runtime/tests/polling.test.ts

@@ -5,7 +5,7 @@ import {
   createDefaultExecutor,
   type DisposableExecutor,
 } from '@graphql-mesh/transport-common';
-import { DefaultLogger, makeDisposable } from '@graphql-mesh/utils';
+import { makeDisposable } from '@graphql-mesh/utils';
 import { normalizedExecutor } from '@graphql-tools/executor';
 import {
   createDeferred,
@@ -17,6 +17,7 @@ import { DisposableSymbols } from '@whatwg-node/disposablestack';
 import { ExecutionResult, GraphQLSchema, parse } from 'graphql';
 import { createSchema } from 'graphql-yoga';
 import { describe, expect, it, vi } from 'vitest';
+import { getDefaultLogger } from '../../runtime/src/getDefaultLogger';
 import { UnifiedGraphManager } from '../src/unifiedGraphManager';
 
 describe('Polling', () => {
@@ -334,7 +335,7 @@ describe('Polling', () => {
     const unifiedGraphFetcher = vi.fn(() => {
       return graphDeferred ? graphDeferred.promise : unifiedGraph;
     });
-    const logger = new DefaultLogger();
+    const logger = getDefaultLogger();
     await using executor = getExecutorForUnifiedGraph({
       getUnifiedGraph: unifiedGraphFetcher,
       pollingInterval: 10_000,

packages/gateway/src/bin.ts

@@ -3,7 +3,7 @@ import 'dotenv/config'; // inject dotenv options to process.env
 
 import module from 'node:module';
 import type { InitializeData } from '@graphql-hive/importer/hooks';
-import { DefaultLogger } from '@graphql-mesh/utils';
+import { getDefaultLogger } from '../../runtime/src/getDefaultLogger';
 import { enableModuleCachingIfPossible, handleNodeWarnings, run } from './cli';
 
 // @inject-version globalThis.__VERSION__ here
@@ -20,7 +20,7 @@ module.register('@graphql-hive/importer/hooks', {
 enableModuleCachingIfPossible();
 handleNodeWarnings();
 
-const log = new DefaultLogger();
+const log = getDefaultLogger();
 
 run({ log }).catch((err) => {
   log.error(err);

packages/gateway/src/cli.ts

@@ -7,13 +7,13 @@ import {
   InvalidArgumentError,
   Option,
 } from '@commander-js/extra-typings';
-import type {
-  GatewayConfigContext,
-  GatewayConfigProxy,
-  GatewayConfigSubgraph,
-  GatewayConfigSupergraph,
-  GatewayGraphOSReportingOptions,
-  GatewayHiveReportingOptions,
+import {
+  type GatewayConfigContext,
+  type GatewayConfigProxy,
+  type GatewayConfigSubgraph,
+  type GatewayConfigSupergraph,
+  type GatewayGraphOSReportingOptions,
+  type GatewayHiveReportingOptions,
 } from '@graphql-hive/gateway-runtime';
 import type UpstashRedisCache from '@graphql-mesh/cache-upstash-redis';
 import type { JWTAuthPluginOptions } from '@graphql-mesh/plugin-jwt-auth';
@@ -26,8 +26,8 @@ import type {
   MeshPubSub,
   YamlConfig,
 } from '@graphql-mesh/types';
-import { DefaultLogger } from '@graphql-mesh/utils';
 import parseDuration from 'parse-duration';
+import { getDefaultLogger } from '../../runtime/src/getDefaultLogger';
 import { addCommands } from './commands/index';
 import { createDefaultConfigPaths } from './config';
 import { getMaxConcurrency } from './getMaxConcurrency';
@@ -347,7 +347,7 @@ let cli = new Command()
 
 export async function run(userCtx: Partial<CLIContext>) {
   const ctx: CLIContext = {
-    log: userCtx.log || new DefaultLogger(),
+    log: userCtx.log || getDefaultLogger(),
     productName: 'Hive Gateway',
     productDescription: 'Federated GraphQL Gateway',
     productPackageName: '@graphql-hive/gateway',
@@ -362,7 +362,7 @@ export async function run(userCtx: Partial<CLIContext>) {
   cli = cli.name(binName).description(productDescription).version(version);
 
   if (cluster.worker?.id) {
-    ctx.log = ctx.log.child(`Worker #${cluster.worker.id}`);
+    ctx.log = ctx.log.child({ worker: cluster.worker.id });
   }
 
   addCommands(ctx, cli);

packages/gateway/src/commands/handleFork.ts

@@ -10,25 +10,34 @@ export function handleFork(log: Logger, config: { fork?: number }): boolean {
       log.debug(`Forking ${config.fork} workers`);
       for (let i = 0; i < config.fork; i++) {
         const worker = cluster.fork();
+        const workerLogger = log.child({ worker: worker.id });
         worker.once('exit', (code, signal) => {
+          const logData: Record<string, string | number> = {
+            signal,
+          };
+          if (code != null) {
+            logData['code'] = code;
+          }
           if (expectedToExit) {
-            log.debug(
-              `Worker ${worker.process.pid} exited with code ${code} and signal ${signal}`,
-            );
+            workerLogger.debug('exited', logData);
           } else {
-            log.warn(`Worker ${worker.process.pid} exited unexpectedly with code ${code} and signal ${signal}\n
-A restart is recommended to ensure the stability of the service`);
+            workerLogger.error(
+              'exited unexpectedly. A restart is recommended to ensure the stability of the service',
+              logData,
+            );
           }
           workers.delete(worker);
           if (!expectedToExit && workers.size === 0) {
-            log.error(`All workers exited unexpectedly. Exiting`);
+            log.error(`All workers exited unexpectedly. Exiting`, logData);
             process.exit(1);
           }
         });
         workers.add(worker);
       }
       registerTerminateHandler((signal) => {
-        log.info(`Killing workers with ${signal}`);
+        log.info('Killing workers', {
+          signal,
+        });
         expectedToExit = true;
         workers.forEach((w) => {
           w.kill(signal);

packages/gateway/src/commands/handleLoggingOption.ts

@@ -1,5 +1,6 @@
 import { Logger } from '@graphql-mesh/types';
-import { CLIContext, DefaultLogger, LogLevel } from '..';
+import { CLIContext, LogLevel } from '..';
+import { getDefaultLogger } from '../../../runtime/src/getDefaultLogger';
 
 export function handleLoggingConfig(
   loggingConfig: boolean | Logger | LogLevel | undefined,
@@ -9,17 +10,23 @@ export function handleLoggingConfig(
     ctx.log = loggingConfig;
   } else if (typeof loggingConfig === 'boolean') {
     if (!loggingConfig) {
-      if (ctx.log instanceof DefaultLogger) {
+      if ('logLevel' in ctx.log) {
         ctx.log.logLevel = LogLevel.silent;
       } else {
-        ctx.log = new DefaultLogger(ctx.log.name, LogLevel.silent);
+        ctx.log = getDefaultLogger({
+          name: ctx.log.name,
+          level: LogLevel.silent,
+        });
       }
     }
   } else if (typeof loggingConfig === 'number') {
-    if (ctx.log instanceof DefaultLogger) {
+    if ('logLevel' in ctx.log) {
       ctx.log.logLevel = loggingConfig;
     } else {
-      ctx.log = new DefaultLogger(ctx.log.name, loggingConfig);
+      ctx.log = getDefaultLogger({
+        name: ctx.log.name,
+        level: loggingConfig,
+      });
     }
   }
 }