error-reporting: Address doc inconsistencies #2247
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the README file: * Removed documentation on automatically handling uncaughtExceptions since that logic no longer exists in the code. * Removed the statement saying that this project is not an official Google project. * Added clarity to what configuration is needed in different environments. * Removed an invalid reference to the Stackdriver Trace agent for Node.js. * Did some refactoring to make the documentation easier to read.
googlebot
added
the
cla: yes
|
Changes Unknown when pulling 799bc7a on DominicKramer:bug/fix-README-issues into ** on GoogleCloudPlatform:master**. |
ofrobots
suggested changes
Apr 21, 2017
packages/error-reporting/README.md
Outdated
| 1. You need a [Google Cloud project](https://console.cloud.google.com). Your application can run anywhere, but errors are reported to a particular project. | ||
| 1. [Enable the Stackdriver Error Reporting API](https://console.cloud.google.com/apis/api/clouderrorreporting.googleapis.com/overview) for your project. | ||
| 1. The module will only send errors when the `NODE_ENV` environment variable is | ||
| 2. You need a [Google Cloud project](https://console.cloud.google.com). Your application can run anywhere, but errors are reported to a particular project. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
packages/error-reporting/README.md
Outdated
| ## Configuration | ||
|
|
||
| The following code snippet lists all available configuration options. All configuration options are optional. | ||
| The following code snippet lists all available configuration options. Except for the `keyFilename` and `credentials` options, all configuration options are optional. Whether or not the `keyFilename` and `credentials` options are required is outlined in the [Running on Google Cloud Platform](#running-on-google-cloud-platform) section above. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
|
Changes Unknown when pulling c0578a7 on DominicKramer:bug/fix-README-issues into ** on GoogleCloudPlatform:master**. |
ofrobots
approved these changes
Apr 22, 2017
GautamSharda
pushed a commit
that referenced
this pull request
Jan 14, 2026
In the README file: * Removed documentation on automatically handling uncaughtExceptions since that logic no longer exists in the code. * Removed the statement saying that this project is not an official Google project. * Added clarity to what configuration is needed in different environments. * Removed an invalid reference to the Stackdriver Trace agent for Node.js. * Did some refactoring to make the documentation easier to read. * Address GitHub comments
GautamSharda
pushed a commit
that referenced
this pull request
Jan 15, 2026
In the README file: * Removed documentation on automatically handling uncaughtExceptions since that logic no longer exists in the code. * Removed the statement saying that this project is not an official Google project. * Added clarity to what configuration is needed in different environments. * Removed an invalid reference to the Stackdriver Trace agent for Node.js. * Did some refactoring to make the documentation easier to read. * Address GitHub comments
4 tasks
GautamSharda
pushed a commit
that referenced
this pull request
Feb 5, 2026
In the README file: * Removed documentation on automatically handling uncaughtExceptions since that logic no longer exists in the code. * Removed the statement saying that this project is not an official Google project. * Added clarity to what configuration is needed in different environments. * Removed an invalid reference to the Stackdriver Trace agent for Node.js. * Did some refactoring to make the documentation easier to read. * Address GitHub comments
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the README file:
uncaughtExceptions since that logic no longer exists in the
code.
official Google project.
environments.
for Node.js.