Automatic Instrumentation

​

Supported Versions

Odigos uses the official OpenTelemetry instrumentation libraries and SDK components, thus it supports the same Node.js versions as the OpenTelemetry Node.js.

• Node.js runtime versions 14 and above are supported.

​

Traces

Odigos will automatically instrument your Node.js sources to record and collect spans for distributed tracing, by utilizing the OpenTelemetry Node.js Official Instrumentation Libraries.

If you use one of the supported logger libraries, the trace id and span id will be auto-injected into your log records allowing signals correlations between logs and traces.

​

Instrumentation Libraries

The following npm packages will be auto instrumented by Odigos:

​

Node.js Core Modules:

• node:dns Node.js versions >=14
• node:fs Node.js versions >=14
• node:http Node.js versions >=14
• node:https Node.js versions >=14
• node:net Node.js versions >=14

​

HTTP Frameworks:

• connect versions >=3.0.0 <4
• express versions >=4.0.0 <5
• fastify versions >=3.0.0 <5
• graphql versions >=14.0.0 <17
• @hapi/hapi versions >=17.0.0 <22
• koa versions >=2.0.0 <3
• @koa/router versions >=8.0.0
• @nestjs/core versions >=4.0.0 <11
• node:http Node.js versions >=14
• node:https Node.js versions >=14
• restify versions >=4.0.0 <12
• router versions >=1.0.0 <2

​

HTTP Clients:

• node:http Node.js versions >=14
• node:https Node.js versions >=14
• undici versions >=5.12.0

​

RPC (Remote Procedure Call):

• aws-sdk versions >=2.308.0 <3
• @aws-sdk/client-* versions >=3.0.0 <4
• @grpc/grpc-js versions ^1.0.0

​

Messaging Systems Clients:

• amqplib versions >=0.5.5 <1
• kafkajs versions >=0.1.0 <3
• node:http Node.js versions >=14
• node:https Node.js versions >=14
• socket.io versions >=2.0.0 <5

​

Database Clients, ORMs, and data access libraries:

• aws-sdk versions >=2.308.0 <3
• @aws-sdk/client-* versions >=3.0.0 <4
• cassandra-driver versions >=4.4.0 <5
• dataloader versions >=2.0.0 <3
• generic-pool versions >=2.0.0 <4
• ioredis versions >=2.0.0 <6
• knex versions >=0.10.0 <4
• lru-memoizer versions >=1.3.0 <3
• memcached versions >=2.2.0 <3
• mongodb versions >=3.3.0 <7
• mongoose versions >=5.9.7 <7
• mysql versions >=2.0.0 <3
• mysql2 versions >=1.4.2 <4
• pg-pool versions >=2.0.0 <4
• pg versions >=8.0.0 <9
• redis versions >=2.6.0
• tedious versions >=1.11.0 <18

​

Loggers:

Automatic injection of trace context (trace id and span id) into log records for the following loggers:

• bunyan versions >=1.0.0 <2
• pino versions >=5.14.0 <10
• winston versions >=1.0.0 <4