doc: update README.md #706
Merged
Conversation
This file contains 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
googlebot
added
the
cla: yes
Codecov Report
@@ Coverage Diff @@
## master #706 +/- ##
=======================================
Coverage 90.77% 90.77%
=======================================
Files 29 29
Lines 1485 1485
Branches 293 293
=======================================
Hits 1348 1348
Misses 57 57
Partials 80 80Continue to review full report at Codecov.
|
jinwoo
approved these changes
Mar 29, 2018
README.md
Outdated
| This is the trace list that shows a sampling of the incoming requests your application is receiving. You can click on a URI to drill down into the details. This will show you the RPCs made by your application and their associated latency: | ||
|
|
||
|  | ||
| > **Note**: If you source code contains untranspiled [`async/await`][async-await-docs] (introduced in Node 7.6), please see [this section](#tracing-with-async/await) on enabling experimental tracing for `async` functions. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
README.md
Outdated
| * [hapi](https://www.npmjs.com/package/hapi) (versions 8 - 16) | ||
| * [koa](https://www.npmjs.com/package/koa) (version 1) | ||
| * [restify](https://www.npmjs.com/package/restify) (versions 3 - 6) | ||
|
|
||
| The agent will also automatic trace of the following kinds of RPCs: | ||
| The agent will also automatically trace RPCs from the following modules: | ||
| * Outbound HTTP requests through the `http` and `https` core modules |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
README.md
Outdated
|
|
||
| This method, which relies on [async-listener][] to preserve continuations over asynchronous boundaries, works great in most cases. However, it does have some limitations that can prevent us from being able to properly propagate trace context: | ||
| * It is possible that a module does its own queuing of callback functions – effectively merging asynchronous execution contexts. For example, one may write a http request buffering library that queues requests and then performs them in a batch in one shot. In such a case, when all the callbacks fire, they will execute in the context which flushed the queue instead of the context which added the callbacks to the queue. This problem is called the pooling problem or the [user-space queuing problem][queuing-problem], and is a fundamental limitation of JavaScript. If your application uses such code, you will notice that RPCs from many requests are showing up under a single trace, or that certain portions of your outbound RPCs do not get traced. In such cases we try to work around the problem through monkey patching, or by working with the library authors to fix the code to properly propagate context. However, finding problematic code is not always trivial. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
| 1. Your application will need to be using Node.js version 4.0 or greater. | ||
| 1. You will need a project in the [Google Developers Console][cloud-console]. Your application can run anywhere, but the trace data is associated with a particular project. | ||
| 1. [Enable the Trace API](https://console.cloud.google.com/flows/enableapi?apiid=cloudtrace) for your project. | ||
| The Trace Agent supports Node 4+. |
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.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates the README. Some information are out of date, and some are duplicated with the Setting Up Stackdriver Trace for Node.js doc. In general, I also felt like the README was a little bloated, so I have cut it down and re-arranged some sections.