Cloud Functions Node.js Logging Best Practice [166139702]

Assigned

Feature Request

Status Update

No update yet.

Description

vi...@google.com

created issue #1

Aug 24, 2020 07:10PM

For Cloud Functions on Node.js, to have structured logging, we would like to recommend using console.log to get the best user experience, instead of using @google-cloud/logging library.

At this time, in a Cloud Function environment, I would recommend using console.log. You can still use structured logging when you do so:

console.log(JSON.stringify({ severity: 'ERROR', textPayload: 'hello world' })) console.log(JSON.stringify({ severity: 'CRITICAL', name: "john", lastname: "smith" }))

Using console.log should ensure that logs are drained synchronously, which is not currently possible with the @google-cloud/logging library.

Comments

el...@google.com <el...@google.com> #2Aug 24, 2020 11:09PM

Indeed, this would be quite useful - especially when we need to export the certificates to external systems like an NGINX box.

ma...@aivora.es <ma...@aivora.es> #3Apr 15, 2021 12:42PM

This would be useful when one wishes to have a Google managed certificate to load into Istio Ingress.

I'm assuming if this feature is implemented, we will get access to download the private key for any Google managed certificate that was generated with the:

gcloud compute ssl-certificates create

command as well.

ma...@aivora.es <ma...@aivora.es> #4May 9, 2021 12:03PM

This would be a useful feature to add

am...@google.com <am...@google.com> #5May 10, 2021 01:29PM

Extremely important feature! Please introduce asap.

ma...@aivora.es <ma...@aivora.es> #6May 11, 2021 08:16AM

This would be a useful feature to add. In case of GKE, that it could be used by cluster internals in a similar way to how it is used in ingress would be fantastic

ma...@aivora.es <ma...@aivora.es> #7May 12, 2021 02:30PM

One year passed.. Did we know where we stand on this request?

mt...@google.com <mt...@google.com> #8May 12, 2021 05:30PM

Looks like there are two issues here. The original issue about structured logging with console.log, and another about errors not being logged when the function crashes.

For the latter, could you provide some details? Which Node.js runtime are you using, for example?

ja...@google.com <ja...@google.com> #9May 12, 2021 05:37PM

Structured logging via console.log() should work today using Node.js 10 and above. I'm not certain about Node.js 8.

ti...@gmail.com <ti...@gmail.com> #10Dec 9, 2022 10:54PM

At the potential risk of further conflating unrelated issues, I wonder if the original poster was referencing a problem with Structured Logging and Error Reporting. Structured logging does work, in the sense that the structured log entries are written and accessible in Logs Explorer. However, Error Reporting does not pick up structured logs with severity ERROR. For instance, all of the following result in log entries, none of them result in new entries in Error Reporting:

  //  console.error(JSON.stringify({severity: "ERROR", error: new Error("Case 5: I failed you")}));
  //  console.error(JSON.stringify({severity: "ERROR", error: new Error("Case 6: I failed you\nAnd because of that newline, I failed to alert you that I failed you.")}));
  //  const error7 = new Error("Case 7: I failed you");
  //  console.error(JSON.stringify({severity: "ERROR",  message: error7.message, error: error7}));
  //  const error8 = new Error("Case 8: I failed you\nAnd because of that newline, I failed to alert you that I failed you.");
  //  console.error(JSON.stringify({severity: "ERROR", message: error8.message, error: error8}));
  //  console.error(JSON.stringify({severity: "ERROR",  message: "Case 9: I failed you"}));
  //  console.error(JSON.stringify({severity: "ERROR", message: "Case 10: I failed you\nAnd because of that newline, I failed to alert you that I failed you."}));

(These were originally test cases regarding the newline, which is relevant to another issue tracker I am in the process of entering -- but turns out is distinct from the structured logging cases here.)