Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
@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
and @grpc/grpc-js
. Currently, version 1.x
of grpc
and version 1.x
of @grpc/grpc-js
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 or (grpc-js).
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 or examples/grpc-js for examples.
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.
FAQs
OpenTelemetry instrumentation for `@grpc/grpc-js` rpc client and server for gRPC framework
The npm package @opentelemetry/instrumentation-grpc receives a total of 1,405,839 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
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.