You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The following versions of Node.js are known to not be fully instrumented:</p><divclass="itemizedlist"><ulclass="itemizedlist" type="disc"><liclass="listitem">
617
617
v7.10.x - Recommended solution: Upgrade to v8.0.0 or higher to get full support
618
618
</li></ul></div><h3><aid="compatibility-frameworks"></a>Frameworks<ahref="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 <aclass="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><divclass="informaltable"><tablecellpadding="4px" border="1"><colgroup><colclass="col_1" /><colclass="col_2" /><colclass="col_3" /></colgroup><thead><tr><thalign="left" valign="top">Framework </th><thalign="left" valign="top">Version </th><thalign="left" valign="top">Note</th></tr></thead><tbody><tr><tdalign="left" valign="top"><p><aclass="link" href="express.html" title="Get started with Express">Express</a></p></td><tdalign="left" valign="top"><p>^4.0.0</p></td><tdalign="left" valign="top"><p></p></td></tr><tr><tdalign="left" valign="top"><p><aclass="link" href="hapi.html" title="Get started with hapi">hapi</a></p></td><tdalign="left" valign="top"><p>>=9.0.0</p></td><tdalign="left" valign="top"><p></p></td></tr><tr><tdalign="left" valign="top"><p><aclass="link" href="koa.html" title="Get started with Koa">Koa</a> via koa-router</p></td><tdalign="left" valign="top"><p>>=5.2.0 <8.0.0</p></td><tdalign="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><divclass="informaltable"><tablecellpadding="4px" border="1"><colgroup><colclass="col_1" /><colclass="col_2" /><colclass="col_3" /></colgroup><thead><tr><thalign="left" valign="top">Framework </th><thalign="left" valign="top">Version </th><thalign="left" valign="top">Note</th></tr></thead><tbody><tr><tdalign="left" valign="top"><p><aclass="link" href="express.html" title="Get started with Express">Express</a></p></td><tdalign="left" valign="top"><p>^4.0.0</p></td><tdalign="left" valign="top"><p></p></td></tr><tr><tdalign="left" valign="top"><p><aclass="link" href="hapi.html" title="Get started with hapi">hapi</a></p></td><tdalign="left" valign="top"><p>>=9.0.0 <17.0.0</p></td><tdalign="left" valign="top"><p></p></td></tr><tr><tdalign="left" valign="top"><p><aclass="link" href="koa.html" title="Get started with Koa">Koa</a> via koa-router</p></td><tdalign="left" valign="top"><p>>=5.2.0 <8.0.0</p></td><tdalign="left" valign="top"><p>Koa doesn’t have a built in router,
620
620
so we can’t support Koa directly since we rely on router information for full support.
621
621
We currently support the most popular Koa router called <aclass="ulink" href="https://github.com/alexmingoia/koa-router" target="_top">koa-router</a></p></td></tr></tbody></table></div><h3><aid="compatibility-custom-transactions"></a>Custom Transactions<ahref="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><divclass="informaltable"><tablecellpadding="4px" border="1"><colgroup><colclass="col_1" /><colclass="col_2" /><colclass="col_3" /></colgroup><thead><tr><thalign="left" valign="top">Module </th><thalign="left" valign="top">Version </th><thalign="left" valign="top">Note</th></tr></thead><tbody><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/express-graphql" target="_top">express-graphql</a></p></td><tdalign="left" valign="top"><p>^0.6.1</p></td><tdalign="left" valign="top"><p>Will name all transactions by the GraphQL query name</p></td></tr></tbody></table></div><h3><aid="compatibility-tracing-and-instrumentation"></a>Tracing and Instrumentation<ahref="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><divclass="informaltable"><tablecellpadding="4px" border="1"><colgroup><colclass="col_1" /><colclass="col_2" /><colclass="col_3" /></colgroup><thead><tr><thalign="left" valign="top">Module </th><thalign="left" valign="top">Version </th><thalign="left" valign="top">Note</th></tr></thead><tbody><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/graphql" target="_top">graphql</a></p></td><tdalign="left" valign="top"><p>>=0.7.0</p></td><tdalign="left" valign="top"><p>Will trace all
622
+
These modules override that behavior to give better insights into specialized HTTP servers:</p><divclass="informaltable"><tablecellpadding="4px" border="1"><colgroup><colclass="col_1" /><colclass="col_2" /><colclass="col_3" /></colgroup><thead><tr><thalign="left" valign="top">Module </th><thalign="left" valign="top">Version </th><thalign="left" valign="top">Note</th></tr></thead><tbody><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/express-graphql" target="_top">express-graphql</a></p></td><tdalign="left" valign="top"><p>^0.6.1</p></td><tdalign="left" valign="top"><p>Will name all transactions by the GraphQL query name</p></td></tr></tbody></table></div><h3><aid="compatibility-tracing-and-instrumentation"></a>Tracing and Instrumentation<ahref="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><divclass="informaltable"><tablecellpadding="4px" border="1"><colgroup><colclass="col_1" /><colclass="col_2" /><colclass="col_3" /></colgroup><thead><tr><thalign="left" valign="top">Module </th><thalign="left" valign="top">Version </th><thalign="left" valign="top">Note</th></tr></thead><tbody><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/graphql" target="_top">graphql</a></p></td><tdalign="left" valign="top"><p>>=0.7.0 <0.12.0</p></td><tdalign="left" valign="top"><p>Will trace all
and render calls</p></td></tr><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/ioredis" target="_top">ioredis</a></p></td><tdalign="left" valign="top"><p>^2.0.0 || ^3.0.0</p></td><tdalign="left" valign="top"><p>Will
625
625
trace all queries</p></td></tr><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/mongodb-core" target="_top">mongodb-core</a></p></td><tdalign="left" valign="top"><p>^1.2.7 || ^2.0.0</p></td><tdalign="left" valign="top"><p>Will trace all queries. A lot of higher level MongoDB
If you use an unsupported version you might experience missing traces.
644
644
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 <aclass="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><divclass="informaltable"><tablecellpadding="4px" border="1"><colgroup><colclass="col_1" /><colclass="col_2" /><colclass="col_3" /></colgroup><thead><tr><thalign="left" valign="top">Module </th><thalign="left" valign="top">Version </th><thalign="left" valign="top">Note</th></tr></thead><tbody><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/bluebird" target="_top">bluebird</a></p></td><tdalign="left" valign="top"><p>>=2.0.0 <4.0.0</p></td><tdalign="left" valign="top"><p></p></td></tr><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/generic-pool" target="_top">generic-pool</a></p></td><tdalign="left" valign="top"><p>^2.0.0</p></td><tdalign="left" valign="top"><p>Used
645
+
please create a new topic in the <aclass="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><divclass="informaltable"><tablecellpadding="4px" border="1"><colgroup><colclass="col_1" /><colclass="col_2" /><colclass="col_3" /></colgroup><thead><tr><thalign="left" valign="top">Module </th><thalign="left" valign="top">Version </th><thalign="left" valign="top">Note</th></tr></thead><tbody><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/bluebird" target="_top">bluebird</a></p></td><tdalign="left" valign="top"><p>>=2.0.0 <4.0.0</p></td><tdalign="left" valign="top"><p></p></td></tr><tr><tdalign="left" valign="top"><p><aclass="ulink" href="https://www.npmjs.com/package/generic-pool" target="_top">generic-pool</a></p></td><tdalign="left" valign="top"><p>^2.0.0 || ^3.1.0</p></td><tdalign="left" valign="top"><p>Used
646
646
by a lot of database modules like for instance "pg"</p></td></tr></tbody></table></div></div><divclass="navfooter"><spanclass="prev"><ahref="source-maps.html">
0 commit comments