diff --git a/docs/general/events.md b/docs/general/events.md index d4f41e4a16..1c20b2b927 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -3,7 +3,7 @@ linkTitle: Events aliases: [events-general] ---> -# Semantic conventions for events +# Event semantic conventions **Status**: [Development][DocumentStatus] @@ -36,7 +36,7 @@ the event. -## External event compatibility +## Compatibility When recording events from an existing system as OpenTelemetry Events, the system may lack a single name field or require multiple fields to identify the event. diff --git a/docs/general/profiles.md b/docs/general/profiles.md index b52b0aeb08..bbcbc9db14 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -2,7 +2,7 @@ linkTitle: Profiles ---> -# Profiles attributes +# Profile semantic conventions **Status**: [Development][DocumentStatus] @@ -10,7 +10,8 @@ linkTitle: Profiles - [General profiles identification attributes](#general-profiles-identification-attributes) - [Frame types](#frame-types) -- [Compatibility with pprof](#compatibility-with-pprof) +- [Compatibility](#compatibility) + - [Pprof](#pprof) @@ -60,7 +61,9 @@ They may be used in any Profiles record they apply to. -## Compatibility with pprof +## Compatibility + +### Pprof Existing [pprof][pprofLink] formats can be unambiguously mapped to this data model. Reverse mapping from this data model is also possible to the extent that diff --git a/docs/general/trace-compatibility.md b/docs/general/trace-compatibility.md deleted file mode 100644 index 25e60556e0..0000000000 --- a/docs/general/trace-compatibility.md +++ /dev/null @@ -1,54 +0,0 @@ - - -# Semantic conventions for tracing compatibility components - -**Status**: [Development][DocumentStatus] - -This document defines trace semantic conventions used by the -compatibility components, e.g. OpenTracing Shim layer. - - - -- [OpenTracing](#opentracing) - - - -## OpenTracing - -`Link`s created by the OpenTracing Shim MUST set `opentracing.ref_type` -with one of the accepted values, describing the direct causal relationships -between a child Span and a parent Span, as defined by -[OpenTracing](https://github.com/opentracing/specification/blob/master/specification.md). - - - - - - - - -**Attributes:** - -| Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | -|---|---|---|---|---|---| -| [`opentracing.ref_type`](/docs/registry/attributes/opentracing.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Parent-child Reference type [1] | `child_of`; `follows_from` | - -**[1] `opentracing.ref_type`:** The causal relationship between a child Span and a parent Span. - ---- - -`opentracing.ref_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `child_of` | The parent Span depends on the child Span in some capacity | ![Development](https://img.shields.io/badge/-development-blue) | -| `follows_from` | The parent Span doesn't depend in any way on the result of the child Span | ![Development](https://img.shields.io/badge/-development-blue) | - - - - - - -[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/general/trace.md b/docs/general/trace.md index becbe226e5..10f7bbcc28 100644 --- a/docs/general/trace.md +++ b/docs/general/trace.md @@ -1,6 +1,6 @@ # Trace semantic conventions @@ -21,7 +21,6 @@ can still be easily correlated and cross-analyzed. The following semantic conventions for spans are defined: * **[General](attributes.md): General semantic attributes that may be used in describing different kinds of operations.** -* [Compatibility](trace-compatibility.md): For spans generated by compatibility components, e.g. OpenTracing Shim layer. * [CloudEvents](/docs/cloudevents/README.md): Semantic Conventions for the CloudEvents spans. * [Cloud Providers](/docs/cloud-providers/README.md): Semantic Conventions for cloud providers spans. * [Database](/docs/database/database-spans.md): For SQL and NoSQL client call spans. @@ -36,4 +35,45 @@ Apart from semantic conventions for traces, [metrics](metrics.md), [logs](logs.m OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.50.0/specification/resource/sdk.md) with their own [Resource Semantic Conventions](/docs/resource/README.md). +## Compatibility + +This section defines trace semantic conventions used by the +compatibility components, e.g. OpenTracing Shim layer. + +### OpenTracing + +`Link`s created by the OpenTracing Shim MUST set `opentracing.ref_type` +with one of the accepted values, describing the direct causal relationships +between a child Span and a parent Span, as defined by +[OpenTracing](https://github.com/opentracing/specification/blob/master/specification.md). + + + + + + + + +**Attributes:** + +| Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | +|---|---|---|---|---|---| +| [`opentracing.ref_type`](/docs/registry/attributes/opentracing.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Parent-child Reference type [1] | `child_of`; `follows_from` | + +**[1] `opentracing.ref_type`:** The causal relationship between a child Span and a parent Span. + +--- + +`opentracing.ref_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `child_of` | The parent Span depends on the child Span in some capacity | ![Development](https://img.shields.io/badge/-development-blue) | +| `follows_from` | The parent Span doesn't depend in any way on the result of the child Span | ![Development](https://img.shields.io/badge/-development-blue) | + + + + + + [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status