@opencensus/propagation-stackdriver

OpenCensus Stackdriver Propagation for Node.js

OpenCensus Stackdriver Propagation allow other services to create spans with the right context.

This project is still at an early stage of development. It's subject to change.

Installation

Install OpenCensus Stackdriver Propagation with:

npm install @opencensus/propagation-stackdriver

Usage

To propagate span context arround services with Stackdriver Propagation, pass an instance of Stackdriver Propagation to your tracing instance. For Javascript:

const tracing = require('@opencensus/nodejs');
const propagation = require('@opencensus/propagation-stackdriver');

const sd = propagation.v1;

tracing.start({propagation: sd});

Similarly for Typescript:

import * as tracing from '@opencensus/nodejs';
import * as propagation from '@opencensus/propagation-stackdriver';

const sd = propagation.v1;

tracing.start({propagation: sd});

Useful links

• For more information on OpenCensus, visit: https://opencensus.io/
• To checkout the OpenCensus for Node.js, visit: https://github.com/census-instrumentation/opencensus-node
• For help or feedback on this project, join us on gitter

Changelog

0.0.10 - 2019-04-03

• Add optional compressedSize and uncompressedSize params to Span.addMessageEvent
• Add support for tags, status and annotation in Zipkin exporter.
• Add support for Binary propagation format.
• Add support for object(SpanOptions) as an argument for startChildSpan function, similar to startRootSpan.
• Add proto files to exporter-ocagent package. Fixes issue #174.
• Remove ConfigStream behavior from exporter-ocagent. This was unstable and is not currently supported by any other language instrumentation.
• Change default exporter-ocagent port to 55678 to match the default OC Agent port.
• Add support for recording gRPC stats.
• Add support for recording HTTP stats.
• Enforce --strictNullChecks and --noUnusedLocals Compiler Options on [opencensus-instrumentation-http], [opencensus-instrumentation-grpc] and [opencensus-propagation-tracecontext] packages.
• Enforce --strictNullChecks and --noUnusedLocals Compiler Options on [opencensus-exporter-zipkin] packages.
• Add NoRecordRootSpan, NoRecordSpan and NoRecordSpanBase.
• Enforce --strictNullChecks and --noUnusedLocals Compiler Options on [opencensus-exporter-instana] package.
• Add an API globalStats.unregisterExporter().
• Add support for overriding sampling for a span.
• Enforce --strictNullChecks and --noUnusedLocals Compiler Options on [opencensus-exporter-jaeger] packages.
• Add support for recording Exemplars.
• Add TagMetadata that defines the properties associated with a Tag.
• Add HTTP/W3C text format serializer to Tag propagation component.
• Enforce --strictNullChecks and --noUnusedLocals Compiler Options on [opencensus-core] package.
• Please note that there is an API breaking change in methods addMessageEvent(). The field id is now number instead of string.
• Add support for recording exemplars.
• Add a NoRecord RootSpan and Span.
• Add support for child span count.
• Add [opencensus-instrumentation-ioredis] instrumentation plugin.
• Make Stackdriver propagation module consistent with other propagations interface.
• Add support for gRPC tags propagation.
• Use ts-mocha to run tests.
• Add MetricOptions to simplify all addXGauge.