This package has been deprecated

Author message:

Deprecated in favor of @opentelemetry/instrumentation-grpc

TypeScript icon, indicating that this package has built-in type declarations

0.18.2 • Public • Published

OpenTelemetry gRPC Instrumentation for Node.js

NPM Published Version dependencies devDependencies Apache License

This module provides automatic instrumentation for grpc. Currently, version 1.x of the Node.js gRPC library is supported.

For automatic instrumentation see the @opentelemetry/node package.


npm install --save @opentelemetry/plugin-grpc


OpenTelemetry gRPC Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with gRPC.

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

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

const provider = new NodeTracerProvider({
  plugins: {
    grpc: {
      enabled: true,
      // You may use a package name or absolute path to the file.
      path: '@opentelemetry/plugin-grpc',
      // gRPC plugin options

To load all of the supported plugins, use below approach. Each plugin is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing plugins for unused modules.

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

const provider = new NodeTracerProvider();

See examples/grpc for a short example.

gRPC Plugin Options

gRPC plugin accepts the following configuration:

Options Type Description
ignoreGrpcMethods IgnoreMatcher[] gRPC plugin will not trace any methods that match anything in this list. You may pass a string (case-insensitive match), a RegExp object, or a filter function.

Useful links


Apache 2.0 - See LICENSE for more information.

Package Sidebar


npm i @opentelemetry/plugin-grpc

Weekly Downloads






Unpacked Size

56.7 kB

Total Files


Last publish


  • pichlermarc
  • bogdandrutu
  • dyladan