From f70451c801921bc7e0a90a7ae4e4c5d3babcb170 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Thu, 17 Dec 2020 10:01:44 +0100 Subject: [PATCH] Removed distributed tracing extension Signed-off-by: Francesco Guardiani --- documented-extensions.md | 1 - extensions/distributed-tracing.md | 55 ------------------------------- 2 files changed, 56 deletions(-) delete mode 100644 extensions/distributed-tracing.md diff --git a/documented-extensions.md b/documented-extensions.md index 06748b9fe..4b996eaf6 100644 --- a/documented-extensions.md +++ b/documented-extensions.md @@ -39,7 +39,6 @@ information. ## Known Extensions - [Dataref (Claim Check Pattern)](extensions/dataref.md) -- [Distributed Tracing](extensions/distributed-tracing.md) - [Partitioning](extensions/partitioning.md) - [Sampling](extensions/sampled-rate.md) - [Sequence](extensions/sequence.md) diff --git a/extensions/distributed-tracing.md b/extensions/distributed-tracing.md deleted file mode 100644 index ea32bfa6a..000000000 --- a/extensions/distributed-tracing.md +++ /dev/null @@ -1,55 +0,0 @@ -# Distributed Tracing extension - -This extension embeds context from -[Distributed Tracing](https://w3c.github.io/trace-context/) so that distributed -systems can include traces that span an event-driven system. This extension is -meant to contain historical data of the parent trace, in order to diagnose -eventual failures of the system through tracing platforms like Jaeger, Zipkin, -etc. - -## Attributes - -#### traceparent - -- Type: `String` -- Description: Contains a version, trace ID, span ID, and trace options as - defined in [section 3.2](https://w3c.github.io/trace-context/#traceparent-header) -- Constraints - - REQUIRED - -#### tracestate - -- Type: `String` -- Description: a comma-delimited list of key-value pairs, defined by - [section 3.3](https://w3c.github.io/trace-context/#tracestate-header). -- Constraints - - OPTIONAL - -## Using the Distributed Tracing Extension - -The Distributed Tracing Extension is not intended to replace the protocol specific headers for tracing, -like the ones described in [W3C Trace Context](https://w3c.github.io/trace-context/) for HTTP. - -Given a single hop event transmission (from sink to source directly), the Distributed Tracing Extension, -if used, MUST carry the same trace information contained in protocol specific tracing headers. - -Given a multi hop event transmission, the Distributed Tracing Extension, if used, MUST -carry the trace information of the starting trace of the transmission. -In other words, it MUST NOT carry trace information of each individual hop, since this information is usually -carried using protocol specific headers, understood by tools like [OpenTelemetry](https://opentelemetry.io/). - -Middleware between the source and the sink of the event could eventually add a Distributed Tracing Extension -if the source didn't include any, in order to provide to the sink the starting trace of the transmission. - -An example with HTTP: - -```bash -CURL -X POST example/webhook.json \ --H 'ce-id: 1' \ --H 'ce-specversion: 1.0' \ --H 'ce-type: example' \ --H 'ce-source: http://localhost' \ --H 'ce-traceparent: 00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01' \ --H 'traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01' \ --H 'tracestate: rojo=00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01,congo=lZWRzIHRoNhcm5hbCBwbGVhc3VyZS4` -```