@opentelemetry/instrumentation-grpc
Advanced tools
OpenTelemetry grpc automatic instrumentation package.
@opentelemetry/instrumentation-grpc is an npm package that provides automatic instrumentation for gRPC services and clients using OpenTelemetry. This allows you to collect and export telemetry data such as traces and metrics from your gRPC-based applications, which can be used for monitoring and observability purposes.
Automatic gRPC Server Instrumentation
This code sets up automatic instrumentation for a gRPC server. It initializes the OpenTelemetry tracer provider, adds a span processor to export spans to the console, and registers the gRPC instrumentation.
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { ConsoleSpanExporter } = require('@opentelemetry/sdk-trace-base');
const { GrpcInstrumentation } = require('@opentelemetry/instrumentation-grpc');
const provider = new NodeTracerProvider();
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();
const grpcInstrumentation = new GrpcInstrumentation();
grpcInstrumentation.setTracerProvider(provider);Automatic gRPC Client Instrumentation
This code sets up automatic instrumentation for a gRPC client. Similar to the server instrumentation, it initializes the OpenTelemetry tracer provider, adds a span processor to export spans to the console, and registers the gRPC instrumentation.
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { ConsoleSpanExporter } = require('@opentelemetry/sdk-trace-base');
const { GrpcInstrumentation } = require('@opentelemetry/instrumentation-grpc');
const provider = new NodeTracerProvider();
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();
const grpcInstrumentation = new GrpcInstrumentation();
grpcInstrumentation.setTracerProvider(provider);@opentelemetry/instrumentation-http provides automatic instrumentation for HTTP and HTTPS modules in Node.js. It is similar to @opentelemetry/instrumentation-grpc but focuses on HTTP-based communication instead of gRPC.
@opentelemetry/instrumentation-express provides automatic instrumentation for Express.js applications. It is similar to @opentelemetry/instrumentation-grpc but is specifically designed for the Express.js framework.
@opentelemetry/instrumentation-mongodb provides automatic instrumentation for MongoDB operations. It is similar to @opentelemetry/instrumentation-grpc but focuses on MongoDB database interactions.
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/instrumentation-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 instrumentation (gRPC in this case), specify it in the Node Tracer's configuration.
const { NodeTracerProvider } = require('@opentelemetry/node');
const { GrpcInstrumentation } = require('@opentelemetry/instrumentation-grpc');
const provider = new NodeTracerProvider({
// be sure to disable old plugin
plugins: {
grpc: { enabled: false, path: '@opentelemetry/plugin-groc' }
},
});
const grpcInstrumentation = new GrpcInstrumentation({
// see under for available configuration
});
grpcInstrumentation.enable();
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();
See examples/grpc for a short example.
gRPC instrumentation accepts the following configuration:
| Options | Type | Description |
|---|---|---|
ignoreGrpcMethods | IgnoreMatcher[] | gRPC instrumentation 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. |
Apache 2.0 - See LICENSE for more information.
0.15.0
opentelemetry-api-metrics, opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-sdk-node
opentelemetry-api, opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-grpc-utils, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-node, opentelemetry-plugin-fetch, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-tracing, opentelemetry-web
opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto
opentelemetry-api, opentelemetry-core, opentelemetry-instrumentation-http, opentelemetry-node, opentelemetry-plugin-fetch, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-propagator-b3, opentelemetry-shim-opentracing, opentelemetry-tracing
opentelemetry-instrumentation-http, opentelemetry-plugin-http, opentelemetry-plugin-https
opentelemetry-web
opentelemetry-instrumentation-fetch
opentelemetry-exporter-zipkin
opentelemetry-api-metrics, opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-sdk-node
opentelemetry-exporter-collector
opentelemetry-api
opentelemetry-instrumentation
opentelemetry-instrumentation, opentelemetry-node
opentelemetry-instrumentation-grpc, opentelemetry-instrumentation
opentelemetry-core, opentelemetry-tracing
opentelemetry-instrumentation-http
opentelemetry-core, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-grpc-utils, opentelemetry-instrumentation-http, opentelemetry-metrics, opentelemetry-node, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-resources, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
opentelemetry-core
opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto
FAQs
OpenTelemetry instrumentation for `@grpc/grpc-js` rpc client and server for gRPC framework
The npm package @opentelemetry/instrumentation-grpc receives a total of 696,760 weekly downloads. As such, @opentelemetry/instrumentation-grpc popularity was classified as popular.
We found that @opentelemetry/instrumentation-grpc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.