From c65428b52eeea15db850cf98503e6d28bbdf7fe9 Mon Sep 17 00:00:00 2001 From: Alexandra Konrad <10500694+trisch-me@users.noreply.github.com> Date: Mon, 8 Apr 2024 17:23:19 +0200 Subject: [PATCH] [chore] move opentracing to the registry (#900) Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Co-authored-by: Liudmila Molkova --- .github/ISSUE_TEMPLATE/bug_report.yaml | 1 + .github/ISSUE_TEMPLATE/change_proposal.yaml | 1 + .github/ISSUE_TEMPLATE/new-conventions.yaml | 1 + docs/attributes-registry/README.md | 1 + docs/attributes-registry/opentracing.md | 21 ++++++++++++++++++++ docs/general/trace-compatibility.md | 6 +++--- model/registry/opentracing.yaml | 22 +++++++++++++++++++++ model/trace/compatibility.yaml | 19 ++---------------- 8 files changed, 52 insertions(+), 20 deletions(-) create mode 100644 docs/attributes-registry/opentracing.md create mode 100644 model/registry/opentracing.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 6abd8a910..138ec6c59 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -49,6 +49,7 @@ body: - area:messaging - area:network - area:oci + - area:opentracing - area:os - area:otel - area:peer diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index c064231a7..117491cb4 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -42,6 +42,7 @@ body: - area:messaging - area:network - area:oci + - area:opentracing - area:os - area:otel - area:peer diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index 0b75deac8..f663263c5 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -51,6 +51,7 @@ body: - area:messaging - area:network - area:oci + - area:opentracing - area:os - area:otel - area:peer diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index b69c63fef..c9f832ec7 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -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) diff --git a/docs/attributes-registry/opentracing.md b/docs/attributes-registry/opentracing.md new file mode 100644 index 000000000..727271b54 --- /dev/null +++ b/docs/attributes-registry/opentracing.md @@ -0,0 +1,21 @@ + + +# OpenTracing + +## OpenTracing Attributes + + +| 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) | + diff --git a/docs/general/trace-compatibility.md b/docs/general/trace-compatibility.md index 28d142cdf..958e6c5b4 100644 --- a/docs/general/trace-compatibility.md +++ b/docs/general/trace-compatibility.md @@ -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). - + | 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 | |---|---|---| diff --git a/model/registry/opentracing.yaml b/model/registry/opentracing.yaml new file mode 100644 index 000000000..fd9d68e38 --- /dev/null +++ b/model/registry/opentracing.yaml @@ -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 diff --git a/model/trace/compatibility.yaml b/model/trace/compatibility.yaml index 2ed1de06b..3f906d18c 100644 --- a/model/trace/compatibility.yaml +++ b/model/trace/compatibility.yaml @@ -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