fix: Logging to stdout in Cloud Run creates a JSON object as "message" (

#644)

* fix: Logging to stdout in Cloud Run creates a JSON object as "message"

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

.readme-partials.yml

@@ -164,6 +164,8 @@ body: |-
   It is recommended to set `redirectToStdout: true` in serverless environments like Cloud Functions since it could 
   decrease logging record loss upon execution termination - since all logs are written to `process.stdout` those
   would be picked up by the Cloud Logging Agent running in Google Cloud managed environment. 
+  Note that there is also a `useMessageField` option which controls if "message" field is used to store 
+  structured, non-text data inside `jsonPayload` field when `redirectToStdout` is set. By default `useMessageField` is always `true`.
 
   ```js
   // Imports the Google Cloud client library for Bunyan

README.md

@@ -246,6 +246,8 @@ The agent can parse structured logs printed to `process.stdout` and capture addi
 It is recommended to set `redirectToStdout: true` in serverless environments like Cloud Functions since it could 
 decrease logging record loss upon execution termination - since all logs are written to `process.stdout` those
 would be picked up by the Cloud Logging Agent running in Google Cloud managed environment. 
+Note that there is also a `useMessageField` option which controls if "message" field is used to store 
+structured, non-text data inside `jsonPayload` field when `redirectToStdout` is set. By default `useMessageField` is always `true`.
 
 ```js
 // Imports the Google Cloud client library for Bunyan

package.json

@@ -51,7 +51,7 @@
     "precompile": "gts clean"
   },
   "dependencies": {
-    "@google-cloud/logging": "^10.0.2",
+    "@google-cloud/logging": "^10.1.1",
     "google-auth-library": "^8.0.2"
   },
   "devDependencies": {

src/index.ts

@@ -37,6 +37,7 @@ import * as types from './types/core';
 
 import {ApiResponseCallback} from '@google-cloud/logging/build/src/log';
 import {LogSeverityFunctions} from '@google-cloud/logging/build/src/utils/log-common';
+import {LogSyncOptions} from '@google-cloud/logging/build/src/log-sync';
 
 // Map of Stackdriver logging levels.
 const BUNYAN_TO_STACKDRIVER: Map<number, string> = new Map([
@@ -177,6 +178,7 @@ export class LoggingBunyan extends Writable {
   private defaultCallback?: ApiResponseCallback;
   cloudLog: LogSeverityFunctions;
   redirectToStdout: boolean;
+
   constructor(options?: types.Options) {
     options = options || {};
     super({objectMode: true});
@@ -195,7 +197,14 @@ export class LoggingBunyan extends Writable {
         maxEntrySize: options.maxEntrySize || 250000,
       });
     } else {
-      this.cloudLog = new Logging(options).logSync(this.logName);
+      const logSyncOptions: LogSyncOptions = {
+        useMessageField: options.useMessageField ?? true,
+      };
+      this.cloudLog = new Logging(options).logSync(
+        this.logName,
+        undefined,
+        logSyncOptions
+      );
     }
 
     // serviceContext.service is required by the Error Reporting

src/types/core.d.ts

@@ -91,6 +91,13 @@ export interface Options {
    * agent. Redirected logs are formatted as one line Json string following the structured logging guidelines.
    */
   redirectToStdout?: boolean;
+
+  /**
+   * Boolean flag indicating if "message" field should be used to store structured,
+   * non-text data inside jsonPayload field. This flag applies only when {@link Options#redirectToStdout} is set.
+   * By default this value is true
+   */
+  useMessageField?: boolean;
 }
 
 export interface MonitoredResource {

system-test/logging-bunyan.ts

@@ -57,6 +57,16 @@ describe('LoggingBunyan', function () {
     assert.ok(loggingBunyan.cloudLog instanceof LogSync);
   });
 
+  it('should create LoggingBunyan with LogSync and useMessageField is off', () => {
+    const loggingBunyan = new LoggingBunyan({
+      logName: LOG_NAME,
+      redirectToStdout: true,
+      useMessageField: false,
+    });
+    assert.ok(loggingBunyan.cloudLog instanceof LogSync);
+    assert.ok(loggingBunyan.cloudLog.useMessageField_ === false);
+  });
+
   it('should write diagnostic entry', async () => {
     instrumentation.setInstrumentationStatus(false);
     const start = Date.now();