Skip to content

Commit e421cbe

Browse files
ofrobotsstephenplusplus
authored andcommitted
logging-{w,b}: note about unhandled, uncaught (#2365)
1 parent 03c276d commit e421cbe

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

packages/logging-bunyan/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ var loggingBunyan = require('@google-cloud/logging-bunyan')({
6868

6969
## Error Reporting
7070

71-
Any `Error` objects you log at severity `error` or higher can automatically be picked up by [Stackdriver Error Reporting][error-reporting] if your application is running on Google Cloud Platform. You may also want to see the [@google-cloud/error-reporting][@google-cloud/error-reporting] module which provides direct access to the Error Reporting API.
71+
Any `Error` objects you log at severity `error` or higher can automatically be picked up by [Stackdriver Error Reporting][error-reporting] if your application is running on Google Cloud Platform. Make sure to add logs to your [uncaught exception][uncaught] and [unhandled rejection][unhandled] handlers if you want to see those errors too.
72+
73+
You may also want to see the [@google-cloud/error-reporting][@google-cloud/error-reporting] module which provides direct access to the Error Reporting API.
7274

7375
## Formatting Request Logs
7476

@@ -98,3 +100,5 @@ The `httpRequest` proprety must be a properly formatted [`HttpRequest`][http-req
98100
[dev-console]: https://console.developers.google.com/project
99101
[error-reporting]: https://cloud.google.com/error-reporting/
100102
[@google-cloud/error-reporting]: https://www.npmjs.com/package/@google-cloud/error-reporting
103+
[uncaught]: https://nodejs.org/api/process.html#process_event_uncaughtexception
104+
[unhandled]: https://nodejs.org/api/process.html#process_event_unhandledrejection

packages/logging-winston/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@ winston.add(transport, {
7272

7373
## Error Reporting
7474

75-
Any `Error` objects you log at severity `error` or higher can automatically be picked up by [Stackdriver Error Reporting][error-reporting] if your application is running on Google Cloud Platform. You may also want to see the [@google-cloud/error-reporting][@google-cloud/error-reporting] module which provides direct access to the Error Reporting API.
75+
Any `Error` objects you log at severity `error` or higher can automatically be picked up by [Stackdriver Error Reporting][error-reporting] if your application is running on Google Cloud Platform. Make sure to add logs to your [uncaught exception][uncaught] and [unhandled rejection][unhandled] handlers if you want to see those errors too.
76+
77+
You may also want to see the [@google-cloud/error-reporting][@google-cloud/error-reporting] module which provides direct access to the Error Reporting API.
7678

7779
## Formatting Request Logs
7880

@@ -101,3 +103,5 @@ The `httpRequest` proprety must be a properly formatted [`HttpRequest`][http-req
101103
[http-request-message]: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#HttpRequest
102104
[error-reporting]: https://cloud.google.com/error-reporting/
103105
[@google-cloud/error-reporting]: https://www.npmjs.com/package/@google-cloud/error-reporting
106+
[uncaught]: https://nodejs.org/api/process.html#process_event_uncaughtexception
107+
[unhandled]: https://nodejs.org/api/process.html#process_event_unhandledrejection

0 commit comments

Comments
 (0)