Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wip: update min versions and add more supported libraries #16605

Closed
wants to merge 4 commits into from
Closed

wip: update min versions and add more supported libraries #16605

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93b737a
update min versions and add more supported libraries
svetlanabrennan Mar 20, 2024
aa4f8f1
fix other libraries min support and doc format
svetlanabrennan Mar 20, 2024
9516edb
fix typo
svetlanabrennan Mar 21, 2024
efc4c92
fix mdx errors
svetlanabrennan Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
227 changes: 205 additions & 22 deletions ...agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,42 +206,92 @@ The Node.js agent monitors the performance of Node.js application calls to these
<thead>
<tr>
<th>Datastore</th>
<th>
`npm` module name
</th>

<th>
Minimum module version
</th>

<th>
Minimum agent version
</th>

<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td>[Cassandra](https://www.npmjs.com/package/cassandra-driver)</td>
<td>`cassandra-driver`</td>
<td>3.4.0</td>
<td>1.7.1</td>
<td></td>
</tr>
<tr>
<td>[ElasticSearch](https://www.npmjs.com/package/@elastic/elasticsearch)</td>
<td>`elasticsearch`</td>
<td>7.16.0</td>
<td>11.9.0</td>
<td></td>
</tr>
<tr>
<td>[Memcached](https://www.npmjs.com/package/memcached)</td>
<td>`memcached`</td>
<td>1.0.0</td>
<td>1.33.0</td>
<td></td>
</tr>
<tr>
<td>[MongoDB](https://www.npmjs.com/package/mongodb)</td>
<td>`mongodb`</td>
<td>2.1.0</td>
<td>1.32.0</td>
<td></td>
</tr>
<tr>
<td>MySQL</td>
<td>Via [mysql](https://www.npmjs.com/package/mysql) and [mysql2](https://www.npmjs.com/package/mysql2) packages</td>
<td>[MySQL](https://www.npmjs.com/package/mysql)</td>
<td>`mysql`</td>
<td>2.2.0</td>
<td>1.32.0</td>
<td></td>
</tr>
<tr>
<td>[MySQL 2](https://www.npmjs.com/package/mysql2)</td>
<td>`mysql2`</td>
<td>1.31.1</td>
<td>1.32.0</td>
<td></td>
</tr>
<tr>
<td>[Redis](https://www.npmjs.com/package/redis)</td>
<td>`redis`</td>
<td>2.0.0</td>
<td>1.31.0</td>
<td></td>
</tr>
<tr>
<td>[Postgres](https://www.npmjs.com/package/pg)</td>
<td>`pg`</td>
<td>8.2+</td>
<td>9.0.0</td>
<td>Including the [native](https://www.npmjs.com/package/pg-native) and [pure JavaScript](https://www.npmjs.com/package/pg-js) packages</td>
</tr>
<tr>
<td>[Prisma](https://www.prisma.io/)</td>
<td>[`@prisma/client`](https://www.npmjs.com/package/@prisma/client)</td>
<td>5.0.0</td>
<td>9.11.0</td>
<td>The Prisma instrumentation treats Prisma itself as the datastore, not the underlying SQL or NoSQL datastore that Prisma is configured to use. This means metrics and traces will show Prisma ORM queries such as `find` or `updateMany` and not SQL statements such as `SELECT` or `UPDATE`. As an exception, raw Prisma queries will record the actual raw SQL or NoSQL query.</td>
</tr>
<tr>
<td>[ioredis](https://www.npmjs.com/package/ioredis)</td>
<td>[`ioredis`](https://www.npmjs.com/package/ioredis)</td>
<td>3.0+</td>
<td>1.26.2</td>
<td></td>
</tr>
</tbody>
</table>
</Collapser>
Expand Down Expand Up @@ -303,11 +353,11 @@ We collect [instance details for a variety of databases and database drivers](/d
</td>

<td>
4.0.0
8.2+
</td>

<td>
1.31.0
9.0.0
</td>
</tr>

Expand Down Expand Up @@ -357,7 +407,7 @@ We collect [instance details for a variety of databases and database drivers](/d
</td>

<td>
2.4.1
2.2.0
</td>

<td>
Expand All @@ -367,7 +417,7 @@ We collect [instance details for a variety of databases and database drivers](/d

<tr>
<td>
[MySQL](http://www.mysql.com/)
[MySQL 2](http://www.mysql.com/)
</td>

<td>
Expand Down Expand Up @@ -447,11 +497,11 @@ We collect [instance details for a variety of databases and database drivers](/d
</td>

<td>
4.0.0
5.0.0
</td>

<td>
9.11.0
11.0.0
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -552,13 +602,125 @@ In order to support [APM logs in context](/docs/apm/new-relic-apm/getting-starte
>

[Message queue instrumentation](/docs/agents/nodejs-agent/troubleshooting/troubleshoot-message-consumers) is only available with the [New Relic Node.js agent v2 or higher](/docs/release-notes/agent-release-notes/nodejs-release-notes). Currently supported message queue instrumentation:
* [amqplib](https://www.npmjs.com/package/amqplib).
* [Amazon SQS](https://www.npmjs.com/package/aws-sdk) - both versions 2 and 3 of AWS SDK.
* [Amazon SNS](https://www.npmjs.com/package/aws-sdk) - both versions 2 and 3 of AWS SDK.
<table>
<thead>
<tr>
<th>
Message queue
</th>
<th>
`npm` module name
</th>
<th>
Minimum module version
</th>
<th>
Minimum agent version
</th>
</tr>
</thead>
<tbody>
<tr>
<td>[Amqplib](https://www.npmjs.com/package/amqplib)</td>
<td>`amqplib`</td>
<td>0.5.0</td>
<td>2.0.0</td>
</tr>
<tr>
<td>[Amazon SQS - Amazon SDK V2](https://www.npmjs.com/package/aws-sdk)</td>
<td>`@aws-sdk/client-sqs`</td>
<td>@aws-sdk 2.2.48</td>
<td>6.2.0</td>
</tr>
<tr>
<td>[Amazon SQS - Amazon SDK V3](https://github.com/aws/aws-sdk-js-v3)</td>
<td>`@aws-sdk/client-sqs`</td>
<td>@aws-sdk v3.0.0</td>
<td>8.7.1</td>
</tr>
<tr>
<td>[Amazon SNS - Amazon SDK V2](https://www.npmjs.com/package/aws-sdk)</td>
<td>`@aws-sdk/client-sqs`</td>
<td>@aws-sdk 2.2.48</td>
<td>6.2.0</td>
</tr>
<tr>
<td>[Amazon SNS - Amazon SDK V3](https://github.com/aws/aws-sdk-js-v3)</td>
<td>`@aws-sdk/client-sqs`</td>
<td>@aws-sdk v3.0.0</td>
<td>8.7.1</td>
</tr>
</tbody>
</table>

For other message queue libraries, use [custom instrumentation](/docs/agents/nodejs-agent/supported-features/nodejs-custom-instrumentation#message-client).

</Collapser>

<Collapser
id="other"
title="Other libraries"
>
<table>
<thead>
<tr>
<th>
Library
</th>

<th>
`npm` module name
</th>

<th>
Minimum module version
</th>

<th>
Minimum agent version
</th>
</tr>
</thead>

<tbody>
<tr>
<td>
[Director](https://www.npmjs.com/package/director)
</td>

<td>
`director`
</td>

<td>
1.2+
</td>

<td>
2.0.0
</td>
</tr>
<tr>
<td>
[generic-pool](https://www.npmjs.com/package/generic-pool)
</td>

<td>
`generic-pool`
</td>

<td>
2.4+
</td>

<td>
0.9+
</td>
</tr>
</tbody>
</table>
</Collapser>

<Collapser
id="langtech"
title="Supported languages and technologies"
Expand All @@ -580,8 +742,12 @@ For other message queue libraries, use [custom instrumentation](/docs/agents/nod
Framework
</th>

<th>
`npm` module name
</th>

<th>
Supported versions
Minimum module version
</th>

<th>
Expand All @@ -600,12 +766,13 @@ For other message queue libraries, use [custom instrumentation](/docs/agents/nod
[Express](https://www.npmjs.com/package/express)
</td>

<td>`express`</td>

<td>
4.6.0+
</td>

<td>
</td>
<td>2.6.0</td>

<td>
</td>
Expand All @@ -616,12 +783,14 @@ For other message queue libraries, use [custom instrumentation](/docs/agents/nod
[Restify](https://www.npmjs.com/package/restify)
</td>

<td>
</td>
<td>`restify`</td>

<td>
5.0.0
</td>

<td>2.6.0</td>

<td>
</td>
</tr>
Expand All @@ -632,18 +801,25 @@ For other message queue libraries, use [custom instrumentation](/docs/agents/nod
</td>

<td>
`connect`
</td>

<td>
2.0.0
</td>

<td>
2.6.0
</td>
</tr>

<tr>
<td>
[Hapi](https://www.npmjs.com/package/hapi)
[Hapi](https://www.npmjs.com/package/@hapi/hapi)
</td>

<td>
`@hapi/hapi`
</td>

<td>
Expand All @@ -664,13 +840,14 @@ For other message queue libraries, use [custom instrumentation](/docs/agents/nod
[Koa](https://www.npmjs.com/package/koa)
</td>

<td>
2.0.0+
</td>
<td>`koa`</td>

<td>
2.0.0
</td>

<td>3.2.0</td>

<td>
[External module](https://github.com/newrelic/node-newrelic-koa) loaded with the agent
</td>
Expand All @@ -681,8 +858,10 @@ For other message queue libraries, use [custom instrumentation](/docs/agents/nod
[Fastify](https://www.npmjs.com/package/fastify)
</td>

<td>`fastify`</td>

<td>
2+
2.0.0
</td>

<td>
Expand All @@ -698,8 +877,10 @@ For other message queue libraries, use [custom instrumentation](/docs/agents/nod
[Nest.js](https://nestjs.com/)
</td>

<td>`@nestjs/core`</td>

<td>
8.0.0+
8.0.0
</td>

<td>
Expand All @@ -716,6 +897,8 @@ For other message queue libraries, use [custom instrumentation](/docs/agents/nod
[Next.js](https://www.npmjs.com/package/next)
</td>

<td>`next`</td>

<td>
12.0.9 - 13.3.0
</td>
Expand Down
Loading