0.2.0 • Published 3 years ago

opentelemetry-plugin-sequelize v0.2.0

Weekly downloads
418
License
Apache-2.0
Repository
github
Last release
3 years ago

OpenTelemetry Sequelize Instrumentation for Node.js

NPM version

This module provides automatic instrumentation for Sequelize.

Tested and worked on versions v4, v5 and v6 of Sequelize.

Installation

npm install --save opentelemetry-plugin-sequelize

Usage

To load a specific plugin (sequelize in this case), specify it in the Node Tracer's configuration

const { NodeTracerProvider } = require("@opentelemetry/node");

const provider = new NodeTracerProvider({
  plugins: {
    sequelize: {
      enabled: true,
      // You may use a package name or absolute path to the file.
      path: "opentelemetry-plugin-sequelize",
    },
  },
});

Sequelize Plugin Options

Sequelize plugin has few options available to choose from. You can set the following:

OptionsTypeDescription
responseHookSequelizeResponseCustomAttributesFunctionHook called before response is returned, which allows to add custom attributes to span.
ignoreOrphanedSpansbooleanSet to true if you only want to trace operation which has parent spans

This extension (and many others) was developed by Aspecto with ❤️