feat: add tracecontext propagation (#97)

Based on w3c TraceContext spec: https://w3c.github.io/distributed-tracing/

The `traceparent` header is validated and propagated according to spec.
The only caveat is that the option flags are lost downstream and reset to
"0x1" by the tracer. This will require a refactor of how the tracer treats
the options as certain assumptions are being made that the least-significant
bit will always represent "sampled".

The `tracestate` is propagated downstream, but is currently not mutable by
the tracer. It is simply stored as a string, but types have been generated
to allow this to be refactored into a more structured type in the future,
allowing the tracer to update the tracestate as necessary.

This commit does not attempt to implement the `Correlation-Context` header.

Author: justindsmith

README.md

@@ -28,6 +28,7 @@ OpenCensus collects distributed tracing. It is able to do so by propagating span
 
 - [B3 Propagation](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-propagation-b3/README.md)
 - [Stackdriver Propagation](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-propagation-stackdriver/README.md)
+- [Trace Context Propagation](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-propagation-tracecontext/README.md)
 
 ## Exporters
 

packages/opencensus-core/src/trace/model/root-span.ts

@@ -30,8 +30,10 @@ export class RootSpan extends SpanBase implements types.RootSpan {
   private tracer: types.Tracer;
   /** A list of child spans. */
   private spansLocal: types.Span[];
-  /** It's trace ID. */
+  /** Its trace ID. */
   private traceIdLocal: string;
+  /** Its trace state. */
+  private traceStateLocal: types.TraceState;
   /** set isRootSpan = true */
   readonly isRootSpan = true;
 
@@ -50,6 +52,7 @@ export class RootSpan extends SpanBase implements types.RootSpan {
     this.name = context && context.name ? context.name : 'undefined';
     if (context && context.spanContext) {
       this.parentSpanId = context.spanContext.spanId || '';
+      this.traceStateLocal = context.spanContext.traceState;
     }
     this.spansLocal = [];
     this.kind = context && context.kind ? context.kind : null;
@@ -66,12 +69,20 @@ export class RootSpan extends SpanBase implements types.RootSpan {
     return this.traceIdLocal;
   }
 
+  /** Gets trace state from rootspan instance */
+  get traceState(): types.TraceState {
+    return this.traceStateLocal;
+  }
+
   /** Starts a rootspan instance. */
   start() {
     super.start();
-    this.logger.debug(
-        'starting %s  %o', this.className,
-        {traceId: this.traceId, id: this.id, parentSpanId: this.parentSpanId});
+    this.logger.debug('starting %s  %o', this.className, {
+      traceId: this.traceId,
+      id: this.id,
+      parentSpanId: this.parentSpanId,
+      traceState: this.traceState
+    });
 
     this.tracer.onStartSpan(this);
   }

packages/opencensus-core/src/trace/model/span-base.ts

@@ -65,6 +65,8 @@ export abstract class SpanBase implements types.Span {
   /** Gets the trace ID. */
   abstract get traceId(): string;
 
+  /** Gets the trace state */
+  abstract get traceState(): types.TraceState;
 
   /** Indicates if span was started. */
   get started(): boolean {
@@ -120,7 +122,8 @@ export abstract class SpanBase implements types.Span {
     return {
       traceId: this.traceId,
       spanId: this.id,
-      options: 0x1  // always traced
+      options: 0x1,  // always traced
+      traceState: this.traceState
     };
   }
 

packages/opencensus-core/src/trace/model/span.ts

@@ -42,12 +42,19 @@ export class Span extends SpanBase implements types.Span {
     return this.root.traceId;
   }
 
+  get traceState(): string {
+    return this.root.traceState;
+  }
+
   /** Starts the span instance. */
   start() {
     super.start();
-    this.logger.debug(
-        'starting span  %o',
-        {traceId: this.traceId, spanId: this.id, name: this.name});
+    this.logger.debug('starting span  %o', {
+      traceId: this.traceId,
+      spanId: this.id,
+      name: this.name,
+      traceState: this.traceState
+    });
   }
 
 

packages/opencensus-core/src/trace/model/types.ts

@@ -73,6 +73,8 @@ export interface TraceOptions {
   kind?: string;
 }
 
+export type TraceState = string;
+
 /** Defines the span context */
 export interface SpanContext {
   /** Trace ID */
@@ -81,6 +83,8 @@ export interface SpanContext {
   spanId: string;
   /** Options */
   options?: number;
+  /** TraceState */
+  traceState?: TraceState;
 }
 
 /** Defines an end span event listener */
@@ -128,9 +132,12 @@ export interface Span {
   /** true if span is a RootSpan */
   isRootSpan: boolean;
 
-  /** Constructs a new SpanBaseModel instance. */
+  /** Trace id asscoiated with span. */
   readonly traceId: string;
 
+  /** Trace state associated with span */
+  readonly traceState: TraceState;
+
   /** Indicates if span was started. */
   readonly started: boolean;
 

packages/opencensus-propagation-tracecontext/AUTHORS

@@ -0,0 +1,8 @@
+# This is the list of OpenCensus authors for copyright purposes.
+#
+# This does not necessarily list everyone who has contributed code, since in
+# some cases, their employer may be the copyright holder.  To see the full list
+# of contributors, see the revision history in source control.
+
+Google LLC
+CESAR Team (www.cesar.org.br)

packages/opencensus-propagation-tracecontext/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

packages/opencensus-propagation-tracecontext/README.md

@@ -0,0 +1,46 @@
+# OpenCensus Trace Context Format Propagation for Node.js
+[![Gitter chat][gitter-image]][gitter-url]
+
+OpenCensus Trace Context Format Propagation sends a span context on the wire in an HTTP request, allowing 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 TraceContex Propagation with:
+```bash
+npm install @opencensus/propagation-tracecontext
+```
+
+## Usage
+
+To propagate span context arround services with Trace Context Propagation, pass an instance of Trace Context Propagation to your tracing instance. For Javascript:
+
+```javascript
+const tracing = require('@opencensus/nodejs');
+const propagation = require('@opencensus/propagation-tracecontext');
+
+const traceContext = new propagation.TraceContextFormat();
+
+tracing.start({propagation: traceContext});
+```
+
+Similarly for Typescript:
+
+```typescript
+import * as tracing from '@opencensus/nodejs';
+import { TraceContextFormat } from '@opencensus/propagation-tracecontext';
+
+const traceContext = new TraceContextFormat();
+
+tracing.start({propagation: traceContext});
+```
+
+## Useful links
+- To know more about Trace Context Format propagation, visit: <https://w3c.github.io/distributed-tracing/>
+- 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](https://gitter.im/census-instrumentation/Lobby)
+
+[gitter-image]: https://badges.gitter.im/census-instrumentation/lobby.svg
+[gitter-url]: https://gitter.im/census-instrumentation/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge