Supported Node.js libraries and frameworks

The npm request-promise library is officially deprecated. For more information, see request-promise. ↩︎

The npm request library is officially deprecated. For more information, see request. ↩︎

The Apollo Federation library is officially deprecated. For more information, see Apollo Federation. ↩︎

Instana does not instrument Sequelize directly, but rather the underlying database drivers. Visibility into sequelize actions depends on the database library that you are using together with sequelize (mysql, mysql2, mssql, pg, and pg-native). ↩︎

To capture subsequent calls correctly after you receive a message with AWS SQS, kafkajs, kafka-node, node-rdkafka, kafka-avro, RabbitMQ, amqplib, NATS, NATS streaming, or Google Cloud PubSub, you need to use span.disableAutoEnd() and span.end(). For more information, see ending spans manually. ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎

AWS SQS requires manual async context restoration when you use promises with async or await. ↩︎ ↩︎ ↩︎ ↩︎ ↩︎

Trace continuity is not supported in the following cases:

• For NATS: Because NATS has no message headers. For more information, see NATS tracing docs.
• For NATS streaming: Because NATS streaming has no message headers. For more information, see NATS tracing docs.
• When you use the npm package kafka-node to send or consume messages: Because that package does not support Kafka record headers. For more information, see kafka-node#763 and kafka-node#1309. Trace continuity is supported for Kafka in general starting with Kafka 0.11 for other runtimes and also when you use the package kafkajs. Therefore, you must use kafkajs instead of kafka-node when you use Kafka and Instana in your Node.js application.
• When you use node-rdkafka or kafka-avro to produce messages as streams where the objectMode option is not set to true.

The Nats streaming library is deprecated. The npm package is EOL since February 2024. ↩︎

The kafka-node library is deprecated. ↩︎

If the option dr_cb is set to true when you initialize the Producer, the instrumentation can detect whether a message is sent and create a corresponding span only in that case. If dr_cb is false or unset, the instrumentation assumes that a message is sent (and create a corresponding span) as soon as the Producer.produce method ends. In rare cases, spans might be produced although calling Producer.produce did not result in a message being sent. ↩︎

Bull repeatable jobs that are part of bulk are not properly instrumented due to not being expected by the API. They are expected to be forbidden in the newest versions of Bull ↩︎

Requires express-winston to be configured with statusLevels: true, as Instana captures log messages of only severity warn or higher. ↩︎

Using Apigee Microgateway or edgemicro requires extra installation steps. For more information about this use case, see installation instructions. ↩︎