Trace Context Protocols Registry

W3C Working Group Note

This version:
https://www.w3.org/TR/2019/NOTE-trace-context-protocols-registry-20191119/
Latest published version:
https://www.w3.org/TR/trace-context-protocols-registry/
Latest editor's draft:
https://w3c.github.io/trace-context-protocols-registry/
Previous version:
https://www.w3.org/TR/2019/NOTE-trace-context-protocols-registry-20190314/
Editors:
Sergey Kanzhelev (Microsoft)
Philippe Le Hegaret (W3C)
Participate:
GitHub w3c/trace-context-protocols-registry
File a bug
Commit history
Pull requests
Discussions:
We are on Gitter.

Abstract

This document provides a registry of identified formats of trace context [TRACE-CONTEXT] serialization and deserialization for protocols.

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

This is a registry and is expected to be updated as described in § 2. Registration Entry Requirements and Update Process.

This document was published by the Distributed Tracing Working Group as a Working Group Note.

GitHub Issues are preferred for discussion of this specification. Alternatively, you can send comments to our mailing list. Please send them to public-trace-context@w3.org (archives).

Publication as a Working Group Note does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the W3C Patent Policy.

The group does not expect this document to become a W3C Recommendation.

This document is governed by the 1 March 2019 W3C Process Document.

1. Purpose

This section is non-normative.

Trace context [TRACE-CONTEXT] consists of properties crucial for event correlation, used to monitor the health and reliability of a distributed application. The [TRACE-CONTEXT] specification defines the binding of the distributed trace context to traceparent and tracestate HTTP headers.

This registry is intended to provide a central location for enumerating identified formats of trace context [TRACE-CONTEXT] serialization and deserialization for protocols. By utilizing a common registry, it is possible to provide common trace context serialization and deserialization for other protocols.

2. Registration Entry Requirements and Update Process

  1. Each entry must include a unique protocol, where the scope of uniqueness is the protocol itself.
  2. Each entry should include a link that references a public available specification (PAS) that defines the trace context [TRACE-CONTEXT] serialization and deserialization for that protocol.
  3. Each entry must include contact information of the requestor.

An update to this registry is an addition, change or deletion of a protocol. Any person can request an update to this registry by email notice to the Distributed Tracing Working Group who will place it on an upcoming meeting agenda and notify the requestor. Consideration and disposition of the request is by consensus of the W3C Distributed Tracing Working Group. The Chair will then notify the requestor of the outcome and update the registry accordingly.

3. Registry

This section is the registry of identified formats of trace context [TRACE-CONTEXT] serialization and deserialization for protocols.

Protocol Public Specification(s) Requestor Contact
HTTP [TRACE-CONTEXT] W3C
Binary Trace Context: binary protocol W3C
[AMQP] Trace Context: AMQP protocol W3C
[MQTT] Trace Context: MQTT protocol W3C

A. References

A.1 Normative references

[AMQP]
OASIS Advanced Message Queuing Protocol (AMQP) Version 1.0. OASIS. 29 October 2012. OASIS Standard. URL: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-overview-v1.0.html
[MQTT]
MQTT protocol. MQTT.org. 7 March 2019. URL: https://mqtt.org/
[TRACE-CONTEXT]
Trace Context. Sergey Kanzhelev; Morgan McLean; Alois Reitbauer; Bogdan Drutu; Nik Molnar; Yuri Shkuro. W3C. 13 August 2019. W3C Candidate Recommendation. URL: https://www.w3.org/TR/trace-context/