From 38ceff5e5e424b80f6b7819325ab1edb1c559a73 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Thu, 10 Oct 2019 13:22:14 -0700 Subject: [PATCH] Minor grammar changes, addressed feedback from @haf (#289) * addressed feedback from @haf * Update specification/overview.md Co-Authored-By: Chris Kleinknecht * Update specification/overview.md Co-Authored-By: Chris Kleinknecht * Update specification/overview.md Co-Authored-By: Chris Kleinknecht * Update specification/overview.md Co-Authored-By: Chris Kleinknecht * Update specification/overview.md Co-Authored-By: Chris Kleinknecht * Update specification/overview.md Co-Authored-By: Chris Kleinknecht * Update specification/overview.md Co-Authored-By: Chris Kleinknecht * Update specification/overview.md Co-Authored-By: Chris Kleinknecht --- specification/overview.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/specification/overview.md b/specification/overview.md index 87838ae133d..44abbb60b21 100644 --- a/specification/overview.md +++ b/specification/overview.md @@ -97,21 +97,24 @@ A **Span** may be linked to zero or more other **Spans** (defined by **SpanContexts** inside a single **Trace** or across different **Traces**. **Links** can be used to represent batched operations where a **Span** was initiated by multiple initiating **Span**s, each representing a single incoming -item being processed in the batch. Another example of using a **Link** is to -declare relationship between originating and followed trace. This can be used -when **Trace** enters trusted boundaries of a service and service policy -requires to generate a new Trace instead of trusting incoming Trace context. Or -when long running Trace representing asynchronous data processing operation was -initiated by one of many fast incoming request. - -In case of scatter/gather pattern, when the root operation starts multiple -downstream processing operations and all of them being aggregated back in a -single **Span**, this last **Span** is linked to many operations it -aggregates. All of them are the **Span**s from the same Trace. And similar to -the Parent field of a **Span**. It is recommended, however, to not set parent of -the **Span** in this scenario as semantically parent field represents a single -parent scenario, in many cases parent **Span** fully encloses the child -**Span**. Which is not the case in scatter/gather and batch scenarios. +item being processed in the batch. + +Another example of using a **Link** is to declare the relationship between +the originating and following trace. This can be used when a **Trace** enters trusted +boundaries of a service and service policy requires the generation of a new +Trace rather than trusting the incoming Trace context. The new linked Trace may +also represent a long running asynchronous data processing operation that was +initiated by one of many fast incoming requests. + +When using the scatter/gather (also called fork/join) pattern, the root +operation starts multiple downstream processing operations and all of them are +aggregated back in a single **Span**. This last **Span** is linked to many +operations it aggregates. All of them are the **Span**s from the same Trace. And +similar to the Parent field of a **Span**. It is recommended, however, to not +set parent of the **Span** in this scenario as semantically the parent field +represents a single parent scenario, in many cases the parent **Span** fully +encloses the child **Span**. This is not the case in scatter/gather and batch +scenarios. ## Metrics