Skip to content

Commit a7f599e

Browse files
committed
Explicitly specify instrumentation packages
1 parent 0f18399 commit a7f599e

File tree

1 file changed

+37
-19
lines changed

1 file changed

+37
-19
lines changed

nodejs/README.md

+37-19
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,44 @@ To use, add the layer to your function configuration and then set `AWS_LAMBDA_EX
99

1010
[AWS SDK v3 instrumentation](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-sdk)
1111
is loaded automatically by default.
12-
The instrumentations from the [OTEL auto-instrumentations-node metapackage](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/metapackages/auto-instrumentations-node)
13-
are also included, except for `cucumber, generic-pool, lru-memoizer`.
14-
15-
Following instrumentations from the metapackage are automatically loaded by default:
16-
- `dns`
17-
- `express`
18-
- `graphql`
19-
- `grpc`
20-
- `hapi`
21-
- `http`
22-
- `ioredis`
23-
- `koa`
24-
- `mongodb`
25-
- `mysql`
26-
- `net`
27-
- `pg`
28-
- `redis`
29-
12+
A subset of instrumentations from the [OTEL auto-instrumentations-node metapackage](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/metapackages/auto-instrumentations-node)
13+
are also included.
14+
15+
Following instrumentations from the metapackage are included:
16+
- `amqplib`
17+
- `bunyan`
18+
- `cassandra-driver`
19+
- `connect`
20+
- `dataloader`
21+
- `dns` *- default*
22+
- `express` *- default*
23+
- `fs`
24+
- `graphql` *- default*
25+
- `grpc` *- default*
26+
- `hapi` *- default*
27+
- `http` *- default*
28+
- `ioredis` *- default*
29+
- `kafkajs`
30+
- `knex`
31+
- `koa` *- default*
32+
- `memcached`
33+
- `mongodb` *- default*
34+
- `mongoose`
35+
- `mysql` *- default*
36+
- `mysql2`
37+
- `nestjs-core`
38+
- `net` *- default*
39+
- `pg` *- default*
40+
- `pino`
41+
- `redis` *- default*
42+
- `restify`
43+
- `socket.io`
44+
- `undici`
45+
- `winston`
46+
47+
Instrumentations annotated with "*- default*" are loaded by default.
3048
To only load specific instrumentations, specify the `OTEL_NODE_ENABLED_INSTRUMENTATIONS` environment variable in the lambda configuration.
31-
This disables all the defaults mentioned above, and only enable the ones you specify. Selectively disabling instrumentations from the defaults is also possible with the `OTEL_NODE_DISABLED_INSTRUMENTATIONS` environment variable.
49+
This disables all the defaults, and only enables the ones you specify. Selectively disabling instrumentations from the defaults is also possible with the `OTEL_NODE_DISABLED_INSTRUMENTATIONS` environment variable.
3250

3351
The environment variables should be set to a comma-separated list of the instrumentation package names without the
3452
`@opentelemetry/instrumentation-` prefix.

0 commit comments

Comments
 (0)