Skip to content

Commit e23119d

Browse files
author
Liudmila Molkova
authored
HttpCorrelationProtocol docs update: Add notice about W3C trace-context and deprecate flat-id spec (dotnet#38025)
* Update HttpCorrelationProtocol.md
1 parent 0110344 commit e23119d

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

src/System.Diagnostics.DiagnosticSource/src/FlatRequestId.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# Note
2+
Starting with System.Diagnostics.DiagnosticSource 4.6.0 (that ships with .Net Core 3.0), we are moving towards [W3C Trace-Context](https://www.w3.org/TR/trace-context/) standard. We still support Request-Id ([hierarchical](HierarchicalRequestId.md) version) and it is still the default format for `System.Diagnostics.Activity`.
3+
4+
This specification for `Flat Request-Id` is **deprecated**.
5+
6+
There is no corresponding implementation in .NET and if you are looking into 'flat' correlation protocol - we recommend following [W3C Trace-Context](https://www.w3.org/TR/trace-context/).
7+
18
# Flat Request-Ids
29
This document provide guidance for implementations of [HTTP Correlation Protocol](HttpCorrelationProtocol.md) without [Hierarchical Request-Id](HierarchicalRequestId.md) support or interoperability with services that do not support it.
310

src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1+
2+
# Note
3+
Starting with System.Diagnostics.DiagnosticSource 4.6.0 (that ships with .Net Core 3.0), we are moving towards [W3C Trace-Context](https://www.w3.org/TR/trace-context/) standard. We still support Request-Id ([hierarchical](HierarchicalRequestId.md) version) and it is still the default format for `System.Diagnostics.Activity`.
4+
5+
[Flat Request-Id](FlatRequestId.md) is **deprecated**.
6+
17
# Overview
8+
29
One of the common problems in microservices development is ability to trace request flow from client (application, browser) through all the services involved in processing.
310

411
Typical scenarios include:

0 commit comments

Comments
 (0)