Skip to content

Commit be0b3c6

Browse files
author
Docs User
committed
Updated docs
1 parent 05b79bc commit be0b3c6

16 files changed

+6457
-4174
lines changed

html/branches.yaml

Lines changed: 41 additions & 41 deletions
Large diffs are not rendered by default.

html/en/apm/agent/nodejs/current/compatibility.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -616,10 +616,10 @@ <h2 class="page-title">Guide template</h2>
616616
The following versions of Node.js are known to not be fully instrumented:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
617617
v7.10.x - Recommended solution: Upgrade to v8.0.0 or higher to get full support
618618
</li></ul></div><h3><a id="compatibility-frameworks"></a>Frameworks<a href="https://github.com/elastic/apm-agent-nodejs/edit/master/docs/compatibility.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h3><p>Though you can use Elastic APM <a class="link" href="custom-stack.html" title="Get started with a custom Node.js stack">with any Node.js framework</a>,
619-
we automate a few things for the most popular Node.js modules.</p><p>These are the frameworks that we officially support:</p><div class="informaltable"><table cellpadding="4px" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Framework </th><th align="left" valign="top">Version </th><th align="left" valign="top">Note</th></tr></thead><tbody><tr><td align="left" valign="top"><p><a class="link" href="express.html" title="Get started with Express">Express</a></p></td><td align="left" valign="top"><p>^4.0.0</p></td><td align="left" valign="top"><p></p></td></tr><tr><td align="left" valign="top"><p><a class="link" href="hapi.html" title="Get started with hapi">hapi</a></p></td><td align="left" valign="top"><p>&gt;=9.0.0</p></td><td align="left" valign="top"><p></p></td></tr><tr><td align="left" valign="top"><p><a class="link" href="koa.html" title="Get started with Koa">Koa</a> via koa-router</p></td><td align="left" valign="top"><p>&gt;=5.2.0 &lt;8.0.0</p></td><td align="left" valign="top"><p>Koa doesn’t have a built in router,
619+
we automate a few things for the most popular Node.js modules.</p><p>These are the frameworks that we officially support:</p><div class="informaltable"><table cellpadding="4px" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Framework </th><th align="left" valign="top">Version </th><th align="left" valign="top">Note</th></tr></thead><tbody><tr><td align="left" valign="top"><p><a class="link" href="express.html" title="Get started with Express">Express</a></p></td><td align="left" valign="top"><p>^4.0.0</p></td><td align="left" valign="top"><p></p></td></tr><tr><td align="left" valign="top"><p><a class="link" href="hapi.html" title="Get started with hapi">hapi</a></p></td><td align="left" valign="top"><p>&gt;=9.0.0 &lt;17.0.0</p></td><td align="left" valign="top"><p></p></td></tr><tr><td align="left" valign="top"><p><a class="link" href="koa.html" title="Get started with Koa">Koa</a> via koa-router</p></td><td align="left" valign="top"><p>&gt;=5.2.0 &lt;8.0.0</p></td><td align="left" valign="top"><p>Koa doesn’t have a built in router,
620620
so we can’t support Koa directly since we rely on router information for full support.
621621
We currently support the most popular Koa router called <a class="ulink" href="https://github.com/alexmingoia/koa-router" target="_top">koa-router</a></p></td></tr></tbody></table></div><h3><a id="compatibility-custom-transactions"></a>Custom Transactions<a href="https://github.com/elastic/apm-agent-nodejs/edit/master/docs/compatibility.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h3><p>By default transactions are named based on their matched HTTP route if the framework used is listed above.
622-
These modules override that behavior to give better insights into specialized HTTP servers:</p><div class="informaltable"><table cellpadding="4px" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Module </th><th align="left" valign="top">Version </th><th align="left" valign="top">Note</th></tr></thead><tbody><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/express-graphql" target="_top">express-graphql</a></p></td><td align="left" valign="top"><p>^0.6.1</p></td><td align="left" valign="top"><p>Will name all transactions by the GraphQL query name</p></td></tr></tbody></table></div><h3><a id="compatibility-tracing-and-instrumentation"></a>Tracing and Instrumentation<a href="https://github.com/elastic/apm-agent-nodejs/edit/master/docs/compatibility.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h3><p>The Node.js agent will automatically instrument the following modules to give you detailed performance metrics:</p><div class="informaltable"><table cellpadding="4px" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Module </th><th align="left" valign="top">Version </th><th align="left" valign="top">Note</th></tr></thead><tbody><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/graphql" target="_top">graphql</a></p></td><td align="left" valign="top"><p>&gt;=0.7.0</p></td><td align="left" valign="top"><p>Will trace all
622+
These modules override that behavior to give better insights into specialized HTTP servers:</p><div class="informaltable"><table cellpadding="4px" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Module </th><th align="left" valign="top">Version </th><th align="left" valign="top">Note</th></tr></thead><tbody><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/express-graphql" target="_top">express-graphql</a></p></td><td align="left" valign="top"><p>^0.6.1</p></td><td align="left" valign="top"><p>Will name all transactions by the GraphQL query name</p></td></tr></tbody></table></div><h3><a id="compatibility-tracing-and-instrumentation"></a>Tracing and Instrumentation<a href="https://github.com/elastic/apm-agent-nodejs/edit/master/docs/compatibility.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h3><p>The Node.js agent will automatically instrument the following modules to give you detailed performance metrics:</p><div class="informaltable"><table cellpadding="4px" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Module </th><th align="left" valign="top">Version </th><th align="left" valign="top">Note</th></tr></thead><tbody><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/graphql" target="_top">graphql</a></p></td><td align="left" valign="top"><p>&gt;=0.7.0 &lt;0.12.0</p></td><td align="left" valign="top"><p>Will trace all
623623
queries</p></td></tr><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/handlebars" target="_top">handlebars</a></p></td><td align="left" valign="top"><p>*</p></td><td align="left" valign="top"><p>Will trace compile
624624
and render calls</p></td></tr><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/ioredis" target="_top">ioredis</a></p></td><td align="left" valign="top"><p>^2.0.0 || ^3.0.0</p></td><td align="left" valign="top"><p>Will
625625
trace all queries</p></td></tr><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/mongodb-core" target="_top">mongodb-core</a></p></td><td align="left" valign="top"><p>^1.2.7 || ^2.0.0</p></td><td align="left" valign="top"><p>Will trace all queries. A lot of higher level MongoDB
@@ -642,7 +642,7 @@ <h2 class="page-title">Guide template</h2>
642642
The versions listed are the versions we support.
643643
If you use an unsupported version you might experience missing traces.
644644
This does not impact the stability of your application in any way - only the collected metrics.</p><p>If you do experience missing traces in your performance metrics,
645-
please create a new topic in the <a class="ulink" href="https://discuss.elastic.co/c/apm" target="_top">Elastic APM discuss forum</a> and include information about your dependencies and what data is missing.</p><div class="informaltable"><table cellpadding="4px" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Module </th><th align="left" valign="top">Version </th><th align="left" valign="top">Note</th></tr></thead><tbody><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/bluebird" target="_top">bluebird</a></p></td><td align="left" valign="top"><p>&gt;=2.0.0 &lt;4.0.0</p></td><td align="left" valign="top"><p></p></td></tr><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/generic-pool" target="_top">generic-pool</a></p></td><td align="left" valign="top"><p>^2.0.0</p></td><td align="left" valign="top"><p>Used
645+
please create a new topic in the <a class="ulink" href="https://discuss.elastic.co/c/apm" target="_top">Elastic APM discuss forum</a> and include information about your dependencies and what data is missing.</p><div class="informaltable"><table cellpadding="4px" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Module </th><th align="left" valign="top">Version </th><th align="left" valign="top">Note</th></tr></thead><tbody><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/bluebird" target="_top">bluebird</a></p></td><td align="left" valign="top"><p>&gt;=2.0.0 &lt;4.0.0</p></td><td align="left" valign="top"><p></p></td></tr><tr><td align="left" valign="top"><p><a class="ulink" href="https://www.npmjs.com/package/generic-pool" target="_top">generic-pool</a></p></td><td align="left" valign="top"><p>^2.0.0 || ^3.1.0</p></td><td align="left" valign="top"><p>Used
646646
by a lot of database modules like for instance "pg"</p></td></tr></tbody></table></div></div><div class="navfooter"><span class="prev"><a href="source-maps.html">
647647
« 
648648
Source Map Support</a>

0 commit comments

Comments
 (0)