Skip to content

Commit

Permalink
Fix markdown lint issues
Browse files Browse the repository at this point in the history
  • Loading branch information
joaopgrassi committed Nov 17, 2021
1 parent dd12d12 commit 1b36180
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions extensions/distributed-tracing.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,40 @@
# Distributed Tracing extension

This extension embeds context from
This extension embeds context from
[W3C TraceContext](https://www.w3.org/TR/trace-context/) into a CloudEvent.

The [OpenTelemetry specification](
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/context.md#overview)
defines context as:

> A Context is a propagation mechanism which carries execution-scoped
values across API boundaries and between logically associated execution units. Cross-cutting concerns access their data in-process using the same shared Context object.
> A Context is a propagation mechanism which carries execution-scoped values across
API boundaries and between logically associated execution units. Cross-cutting
concerns access their data in-process using the same shared Context object.

Context propagation enables `Distributed Tracing`.
Also from [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#tracing-signal):

> A distributed trace is a set of events, triggered as a result of a single logical operation, consolidated across various components of an application. A distributed trace contains events that cross process, network and security boundaries.
> A distributed trace is a set of events, triggered as a result of a single
logical operation, consolidated across various components of an application.
A distributed trace contains events that cross process, network and security boundaries.

## Using the Distributed Tracing Extension

The [OpenTelemetry Semantic Conventions for CloudEvents](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/cloudevents.md) defines in which scenarios
this extension should be used and how to use it.
The
[OpenTelemetry Semantic Conventions for CloudEvents](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/cloudevents.md)
defines in which scenarios this extension should be used and how to use it.

## Attributes

#### traceparent
### traceparent

- Type: `String`
- Description: Contains a version, trace ID, span ID, and trace options as
defined in [section 3.2](https://www.w3.org/TR/trace-context/#traceparent-header)
- Constraints
- REQUIRED

#### tracestate
### tracestate

- Type: `String`
- Description: a comma-delimited list of key-value pairs, defined by
Expand Down

0 comments on commit 1b36180

Please sign in to comment.