From 5fae164e51f7e4308643f6ec37c26d92b948ab94 Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Mon, 5 Aug 2024 22:06:55 -0700 Subject: [PATCH] cleanup --- specification/trace/api.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/specification/trace/api.md b/specification/trace/api.md index 36c5dd0c977..253135096d4 100644 --- a/specification/trace/api.md +++ b/specification/trace/api.md @@ -751,17 +751,14 @@ This functionality MUST be fully implemented in the API, and SHOULD NOT be overr `SpanKind` clarifies the relationship between Spans that are correlated via parent/child relationships or span links. `SpanKind` describes two independent -properties that benefit tracing systems during analysis. - -The first property described by `SpanKind` reflects whether span describes an -outgoing request to a remote service (CLIENT and PRODUCER spans) or whether -it handles request from an external service (SERVER and CONSUMER spans). - -The second property described by `SpanKind` reflects whether a Span represents a -synchronous call. Spans that describe synchronous operations (SERVER and CLIENT), -under ordinary circumstances, end after all its children complete. It can be -useful for tracing systems to know this property, since synchronous Spans may -contribute to the overall trace latency. Asynchronous scenarios can be remote or local. +properties that benefit tracing systems during analysis: + +1. Whether span represents an outgoing request to a remote service (CLIENT and PRODUCER spans) + or a processing of request initiated externally (SERVER and CONSUMER spans). +2. Whether a Span represents a synchronous call. Spans that describe synchronous operations + (SERVER and CLIENT) end after all its children complete under ordinary circumstances. + It can be useful for tracing systems to know this property, since synchronous Spans may + contribute to the overall trace latency. Asynchronous scenarios can be remote or local. In order for `SpanKind` to be meaningful, callers SHOULD arrange that a single Span does not serve more than one purpose. For example, a