From 965bbabfb11dbad8dc4581a1f1e85e73df26c52e Mon Sep 17 00:00:00 2001 From: Ruben Vargas Date: Tue, 19 May 2020 11:28:12 -0500 Subject: [PATCH 1/2] docs: document CorrelationContext propagator under Built-in Implementations section Signed-off-by: Ruben Vargas --- packages/opentelemetry-core/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/packages/opentelemetry-core/README.md b/packages/opentelemetry-core/README.md index 491c1041f8..64056a8d31 100644 --- a/packages/opentelemetry-core/README.md +++ b/packages/opentelemetry-core/README.md @@ -55,6 +55,17 @@ const { CompositePropagator } = require("@opentelemetry/core"); api.propagation.setGlobalPropagator(new CompositePropagator()); ``` +#### Correlation Context Propagator +Provides a text-based approach to propagate [correlation context](https://w3c.github.io/correlation-context/) to remote services using the [OpenTelemetry CorrelationContext Propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/correlationcontext/api.md#header-name) HTTP headers. + +```js +const api = require("@opentelemetry/api"); +const { HttpCorrelationContext } = require("@opentelemetry/core"); + +/* Set Global Propagator */ +api.propagation.setGlobalPropagator(new HttpCorrelationContext()); +``` + ### Built-in Sampler Sampler is used to make decisions on `Span` sampling. From 44157dc38b0792f78278ff2010655ece2c4237e9 Mon Sep 17 00:00:00 2001 From: Ruben Vargas Date: Tue, 19 May 2020 12:23:32 -0500 Subject: [PATCH 2/2] docs: add corelation propagation entry to Built-in Propagators section Signed-off-by: Ruben Vargas --- packages/opentelemetry-core/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/opentelemetry-core/README.md b/packages/opentelemetry-core/README.md index 64056a8d31..8aa5f23148 100644 --- a/packages/opentelemetry-core/README.md +++ b/packages/opentelemetry-core/README.md @@ -13,6 +13,7 @@ This package provides default implementations of the OpenTelemetry API for trace * [HttpTraceContext Propagator](#httptracecontext-propagator) * [B3 Propagator](#b3-propagator) * [Composite Propagator](#composite-propagator) + * [Correlation Context Propagator](#correlation-context-propagator) - [Built-in Sampler](#built-in-sampler) * [Always Sampler](#always-sampler) * [Never Sampler](#never-sampler)