specify traceId and spanId format

open-telemetry · Jun 17, 2019 · 424c9fd · 424c9fd
1 parent 52e53ab
commit 424c9fd
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/packages/opentelemetry-types/src/trace/span_context.ts b/packages/opentelemetry-types/src/trace/span_context.ts
@@ -19,9 +19,18 @@
  * propagated along side of a distributed context.
  */
 export interface SpanContext {
-  /** The ID of the trace that this span belongs to. */
+  /**
+   * The ID of the trace that this span belongs to. It is worldwide unique
+   * with practically sufficient probability by being made as 16 randomly
+   * generated bytes, encoded as a 32 lowercase hex characters corresponding to
+   * 128 bits.
+   */
   traceId: string;
-  /** The ID of the Span. */
+  /**
+   * The ID of the Span. It is globally unique with practically sufficient
+   * probability by being made as 8 randomly generated bytes, encoded as a 16
+   * lowercase hex characters corresponding to 64 bits.
+   */
   spanId: string;
   /**
    * Trace options to propagate.