[chore] move opentracing to the registry (#900)

Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com>
Co-authored-by: Liudmila Molkova <limolkova@microsoft.com>
This commit is contained in:
Alexandra Konrad 2024-04-08 17:23:19 +02:00 committed by GitHub
parent a776eaf3fc
commit c65428b52e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 52 additions and 20 deletions

View File

@ -49,6 +49,7 @@ body:
- area:messaging - area:messaging
- area:network - area:network
- area:oci - area:oci
- area:opentracing
- area:os - area:os
- area:otel - area:otel
- area:peer - area:peer

View File

@ -42,6 +42,7 @@ body:
- area:messaging - area:messaging
- area:network - area:network
- area:oci - area:oci
- area:opentracing
- area:os - area:os
- area:otel - area:otel
- area:peer - area:peer

View File

@ -51,6 +51,7 @@ body:
- area:messaging - area:messaging
- area:network - area:network
- area:oci - area:oci
- area:opentracing
- area:os - area:os
- area:otel - area:otel
- area:peer - area:peer

View File

@ -57,6 +57,7 @@ Currently, the following namespaces exist:
* [Network](network.md) * [Network](network.md)
* [OCI](oci.md) * [OCI](oci.md)
* [OpenTelemetry](otel.md) * [OpenTelemetry](otel.md)
* [OpenTracing](opentracing.md)
* [OS](os.md) * [OS](os.md)
* [Peer](peer.md) * [Peer](peer.md)
* [Process](process.md) * [Process](process.md)

View File

@ -0,0 +1,21 @@
<!--- Hugo front matter used to generate the website version of this page:
--->
# OpenTracing
## OpenTracing Attributes
<!-- semconv registry.opentracing(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `opentracing.ref_type` | string | Parent-child Reference type [1] | `child_of` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
**[1]:** 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 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `follows_from` | The parent Span doesn't depend in any way on the result of the child Span | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->

View File

@ -24,14 +24,14 @@ with one of the accepted values, describing the direct causal relationships
between a child Span and a parent Span, as defined by between a child Span and a parent Span, as defined by
[OpenTracing](https://github.com/opentracing/specification/blob/master/specification.md). [OpenTracing](https://github.com/opentracing/specification/blob/master/specification.md).
<!-- semconv opentracing --> <!-- semconv opentracing(full) -->
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---| |---|---|---|---|---|---|
| `opentracing.ref_type` | string | Parent-child Reference type [1] | `child_of` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`opentracing.ref_type`](../attributes-registry/opentracing.md) | string | Parent-child Reference type [1] | `child_of` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
**[1]:** The causal relationship between a child Span and a parent Span. **[1]:** The causal relationship between a child Span and a parent Span.
`opentracing.ref_type` MUST be one of the following: `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 | | Value | Description | Stability |
|---|---|---| |---|---|---|

View File

@ -0,0 +1,22 @@
groups:
- id: registry.opentracing
prefix: opentracing
type: attribute_group
brief: Attributes used by the OpenTracing Shim layer.
attributes:
- id: ref_type
brief: 'Parent-child Reference type'
stability: experimental
note: >
The causal relationship between a child Span and a parent Span.
type:
allow_custom_values: true
members:
- id: child_of
value: 'child_of'
brief: "The parent Span depends on the child Span in some capacity"
stability: experimental
- id: follows_from
value: 'follows_from'
brief: "The parent Span doesn't depend in any way on the result of the child Span"
stability: experimental

View File

@ -1,24 +1,9 @@
groups: groups:
- id: opentracing - id: opentracing
prefix: opentracing
type: span type: span
brief: 'This document defines semantic conventions for the OpenTracing Shim' brief: 'This document defines semantic conventions for the OpenTracing Shim'
note: > note: >
These conventions are used by the OpenTracing Shim layer. These conventions are used by the OpenTracing Shim layer.
attributes: attributes:
- id: ref_type - ref: opentracing.ref_type
brief: 'Parent-child Reference type' requirement_level: recommended
stability: experimental
note: >
The causal relationship between a child Span and a parent Span.
type:
allow_custom_values: false
members:
- id: child_of
value: 'child_of'
brief: "The parent Span depends on the child Span in some capacity"
stability: experimental
- id: follows_from
value: 'follows_from'
brief: "The parent Span doesn't depend in any way on the result of the child Span"
stability: experimental