feat: Add ENV var to use JSON logging (#4474)

Signed-off-by: kasey-alusi-vcc <[email protected]>

Author: kasey-alusi-vcc

.env.http.example

@@ -114,4 +114,5 @@ OPERATOR_KEY_MAIN=               # Operator private key used to sign transaction
 # MULTI_SET=false                # Implementation for setting multiple K/V pairs
 
 # ========== DEVELOPMENT & TESTING ==========
-# LOG_LEVEL=trace                # Logging level (trace, debug, info, warn, error, fatal) 
+# LOG_LEVEL=trace                # Logging level (trace, debug, info, warn, error, fatal)
+# PRETTY_LOGS_ENABLED            # Enable pino-pretty logging (true) or json logging (false)

.env.ws.example

@@ -63,4 +63,4 @@ SUBSCRIPTIONS_ENABLED=true       # Must be true for the WebSocket server to func
 # CLIENT_TRANSPORT_SECURITY=false # Enable or disable TLS for both networks
 # USE_ASYNC_TX_PROCESSING=true   # If true, returns tx hash immediately after prechecks
 # LOG_LEVEL=trace                # Logging level (trace, debug, info, warn, error, fatal)
- 
+# PRETTY_LOGS_ENABLED            # Enable pino-pretty logging (true) or json logging (false)

docs/configuration.md

@@ -121,6 +121,7 @@ Unless you need to set a non-default value, it is recommended to only populate o
 | `HEDERA_NETWORK`                    | ""                                                                                                                                                                                                   | Which network to connect to. Automatically populates the main node & mirror node endpoints. Can be `previewnet`, `testnet`, `mainnet` or a map of network IPs -> node accountIds e.g. `{"127.0.0.1:50211":"0.0.3"}`               |
 | `INPUT_SIZE_LIMIT`                  | "1mb"                                                                                                                                                                                                | The [koa-jsonrpc](https://github.com/Bitclimb/koa-jsonrpc) maximum size allowed for requests                                                                                                                                      |
 | `LOG_LEVEL`                         | "trace"                                                                                                                                                                                              | The logging level for the application. Valid values are `trace`, `debug`, `info`, `warn`, `error`, and `fatal`.                                                                                                                   |
+| `PRETTY_LOGS_ENABLED`               | "true"                                                                                                                                                                                               | Controls the logging output format. When set to `true` (default), uses human-readable pretty format with colors. When set to `false`, uses structured JSON format for log aggregation systems.                                    |
 | `MAX_BLOCK_RANGE`                   | "5"                                                                                                                                                                                                  | The maximum block number greater than the mirror node's latest block to query for                                                                                                                                                 |
 | `OPERATOR_ID_MAIN`                  | ""                                                                                                                                                                                                   | Operator account ID used to pay for transactions. In `S.R.N` format, e.g. `0.0.1001`.                                                                                                                                             |
 | `OPERATOR_KEY_FORMAT`               | "DER"                                                                                                                                                                                                | Operator private key format. Valid types are `DER`, `HEX_ECDSA`, or `HEX_ED25519`                                                                                                                                                 |

packages/config-service/src/services/globalConfig.ts

@@ -368,6 +368,11 @@ const _CONFIG = {
     required: false,
     defaultValue: 'trace',
   },
+  PRETTY_LOGS_ENABLED: {
+    type: 'boolean',
+    required: false,
+    defaultValue: true,
+  },
   MAX_BLOCK_RANGE: {
     type: 'number',
     required: false,

packages/server/src/server.ts

@@ -18,6 +18,8 @@ import { spec } from './koaJsonRpc/lib/RpcError';
 // https://nodejs.org/api/async_context.html#asynchronous-context-tracking
 const context = new AsyncLocalStorage<{ requestId: string }>();
 
+const prettyLogsEnabled = ConfigService.get('PRETTY_LOGS_ENABLED');
+
 const mainLogger = pino({
   name: 'hedera-json-rpc-relay',
   level: ConfigService.get('LOG_LEVEL'),
@@ -26,16 +28,19 @@ const mainLogger = pino({
     const store = context.getStore();
     return store ? { requestId: `[Request ID: ${store.requestId}] ` } : {};
   },
-  transport: {
-    target: 'pino-pretty',
-    options: {
-      colorize: true,
-      translateTime: true,
-      messageFormat: '{requestId}{msg}',
-      // Ignore one or several keys, nested keys are supported with each property delimited by a dot character (`.`)
-      ignore: 'requestId',
+  // Use pino-pretty when PRETTY_LOGS_ENABLED is true (default), otherwise use JSON format
+  ...(prettyLogsEnabled && {
+    transport: {
+      target: 'pino-pretty',
+      options: {
+        colorize: true,
+        translateTime: true,
+        messageFormat: '{requestId}{msg}',
+        // Ignore one or several keys, nested keys are supported with each property delimited by a dot character (`.`)
+        ignore: 'requestId',
+      },
     },
-  },
+  }),
 });
 
 export const logger = mainLogger.child({ name: 'rpc-server' });