From 558d3ea74e551c93a0d8767b9467cec9a0c09fb3 Mon Sep 17 00:00:00 2001 From: Ruben Vargas Date: Tue, 19 May 2020 11:28:12 -0500 Subject: [PATCH] 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 491c1041f82..d29226533a5 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 [correlational 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.