Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@opentelemetry/propagator-grpc-census-binary

0.8.0 • Public • Published

OpenTelemetry Propagator gRPC Census

Gitter chat NPM Published Version dependencies devDependencies Apache License

OpenTelemetry gRPC Census propagator provides gRPC header propagation for systems that use the OpenCensus 'grpc-trace-bin' binary header format. This allows for context propagation when either:

  • incoming gRPC calls come from services already instrumented using OpenCensus
  • outgoing gRPC calls go to services already instrumented using OpenCensus

This propagator works in conjunction with the OpenTelemetry gRPC plugin.

Example of usage:

const { NodeTracerProvider } = require('@opentelemetry/node');
const { GrpcCensusPropagator } = require("@opentelemetry/propagator-grpc-census-binary");
 
const provider = new NodeTracerProvider({
  plugins: {
    grpc: {
      enabled: true,
      path: '@opentelemetry/plugin-grpc',
    }
  }
});
 
// Register GrpcCensusPropagator so we can propagate content using
// the 'grpc-trace-bin' header in our incoming/outgoing gRPC calls.
provider.register({
  propagator: new GrpcCensusPropagator()
});

Implementation Details

See binary-format.ts for equivalent encoding/decoding of the format in OpenCensus. Note: the author of the OpenCensus binary format, ~mayurkale22, also created BinaryTraceContext.ts in opentelemetry-core but that was subsequently removed as part of PR #804. The implementation of GrpcCensusPropagator in this module uses a version of BinaryTraceContext.ts inspired by Mayur's previous work (with minor modifications e.g. there is no longer a BinaryFormat interface to implement).

Useful links

License

Apache 2.0 - See LICENSE for more information.

Install

npm i @opentelemetry/propagator-grpc-census-binary

DownloadsWeekly Downloads

4

Version

0.8.0

License

Apache-2.0

Unpacked Size

33.9 kB

Total Files

11

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar