Skip to content

Commit

Permalink
[chore] move opentracing to the registry (#900)
Browse files Browse the repository at this point in the history
Co-authored-by: Joao Grassi <[email protected]>
Co-authored-by: Liudmila Molkova <[email protected]>
  • Loading branch information
3 people authored Apr 8, 2024
1 parent a776eaf commit c65428b
Show file tree
Hide file tree
Showing 8 changed files with 52 additions and 20 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ body:
- area:messaging
- area:network
- area:oci
- area:opentracing
- area:os
- area:otel
- area:peer
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ body:
- area:messaging
- area:network
- area:oci
- area:opentracing
- area:os
- area:otel
- area:peer
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ body:
- area:messaging
- area:network
- area:oci
- area:opentracing
- area:os
- area:otel
- area:peer
Expand Down
1 change: 1 addition & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Currently, the following namespaces exist:
* [Network](network.md)
* [OCI](oci.md)
* [OpenTelemetry](otel.md)
* [OpenTracing](opentracing.md)
* [OS](os.md)
* [Peer](peer.md)
* [Process](process.md)
Expand Down
21 changes: 21 additions & 0 deletions docs/attributes-registry/opentracing.md
Original file line number Diff line number Diff line change
@@ -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 -->
6 changes: 3 additions & 3 deletions docs/general/trace-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[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 |
|---|---|---|---|---|---|
| `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.

`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 |
|---|---|---|
Expand Down
22 changes: 22 additions & 0 deletions model/registry/opentracing.yaml
Original file line number Diff line number Diff line change
@@ -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
19 changes: 2 additions & 17 deletions model/trace/compatibility.yaml
Original file line number Diff line number Diff line change
@@ -1,24 +1,9 @@
groups:
- id: opentracing
prefix: opentracing
type: span
brief: 'This document defines semantic conventions for the OpenTracing Shim'
note: >
These conventions are 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: 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
- ref: opentracing.ref_type
requirement_level: recommended

0 comments on commit c65428b

Please sign in to comment.