@opencensus/web-propagation-tracecontext

OpenCensus Trace Context format propagation for web browsers

For overview and usage info see the main OpenCensus Web readme.

OpenCensus Trace Context format propagation provides utilities to serialize and deserialize a trace context header in the W3C Trace Context format.

The library is in alpha stage and the API is subject to change.

Usage

Currently the primary intended usage of OpenCensus Web is to collect spans from the resource timing waterfall of an initial page load. See the OpenCensus Web readme for details.

This package is currently used to deserialize the window.traceparent global variable that the server can send back to the client to indicate the parent trace context for the initial page load.

In the future we would like to support propagating trace contextspans for XHRs, and this library could be used to also serialize a traceparent header to send along to XHR calls.

Useful links

• For more information on OpenCensus, visit: https://opencensus.io/
• For more about OpenCensus Web: https://github.com/census-instrumentation/opencensus-web
• For help or feedback on this project, join us on gitter

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.0.1 - 2019-04-26

• TypeScript interfaces and enums extracted from the @opencensus/core package of [opencensus-node][opencensus-node-url]
• Initial Tracer and Span implementations. The tracer only supports a single root span at a time within a browser tab.
• Exporter to write traces to the OpenCensus Agent via its [HTTP/JSON feature][oc-agent-http-url].
• Instrumentation to generate trace spans for the resource timing waterfall of an initial page load.
• Option to link the initial HTML load client span with its server-side span by having the client write a traceparent global variable in [trace context W3C draft format][trace-context-url].
• WebPack build scripts to generate JS bundles to enable adding instrumentation of the initial page load spans and exporting them to the OpenCensus agent.