Skip to content

Commit 88ea598

Browse files
Provide consistent compatability guidance for signals
1 parent e4bb1fd commit 88ea598

File tree

4 files changed

+44
-56
lines changed

4 files changed

+44
-56
lines changed

docs/general/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ the event.
3636

3737
<!-- Body use cases are not clear - see https://github.com/open-telemetry/semantic-conventions/issues/1651 for the context.-->
3838

39-
## External event compatibility
39+
## Compatibility
4040

4141
When recording events from an existing system as OpenTelemetry Events, the system
4242
may lack a single name field or require multiple fields to identify the event.

docs/general/profiles.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ They may be used in any Profiles record they apply to.
5858
<!-- END AUTOGENERATED TEXT -->
5959
<!-- endsemconv -->
6060

61-
## Compatibility with pprof
61+
## Compatibility
62+
63+
### Pprof
6264

6365
Existing [pprof][pprofLink] formats can be unambiguously mapped to this data
6466
model. Reverse mapping from this data model is also possible to the extent that

docs/general/trace-compatibility.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

docs/general/trace.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--- Hugo front matter used to generate the website version of this page:
22
linkTitle: Trace
3-
aliases: [trace-general]
3+
aliases: [trace-general, trace-compatibility]
44
--->
55

66
# Trace semantic conventions
@@ -21,7 +21,6 @@ can still be easily correlated and cross-analyzed.
2121
The following semantic conventions for spans are defined:
2222

2323
* **[General](attributes.md): General semantic attributes that may be used in describing different kinds of operations.**
24-
* [Compatibility](trace-compatibility.md): For spans generated by compatibility components, e.g. OpenTracing Shim layer.
2524
* [CloudEvents](/docs/cloudevents/README.md): Semantic Conventions for the CloudEvents spans.
2625
* [Cloud Providers](/docs/cloud-providers/README.md): Semantic Conventions for cloud providers spans.
2726
* [Database](/docs/database/database-spans.md): For SQL and NoSQL client call spans.
@@ -36,4 +35,43 @@ Apart from semantic conventions for traces, [metrics](metrics.md), [logs](logs.m
3635
OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/specification/resource/sdk.md) with their own
3736
[Resource Semantic Conventions](/docs/resource/README.md).
3837

38+
## Compatibility
39+
40+
This section defines trace semantic conventions used by the
41+
compatibility components, e.g. OpenTracing Shim layer.
42+
43+
### OpenTracing
44+
45+
`Link`s created by the OpenTracing Shim MUST set `opentracing.ref_type`
46+
with one of the accepted values, describing the direct causal relationships
47+
between a child Span and a parent Span, as defined by
48+
[OpenTracing](https://github.com/opentracing/specification/blob/master/specification.md).
49+
50+
<!-- semconv opentracing -->
51+
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
52+
<!-- see templates/registry/markdown/snippet.md.j2 -->
53+
<!-- prettier-ignore-start -->
54+
<!-- markdownlint-capture -->
55+
<!-- markdownlint-disable -->
56+
57+
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
58+
|---|---|---|---|---|---|
59+
| [`opentracing.ref_type`](/docs/registry/attributes/opentracing.md) | string | Parent-child Reference type [1] | `child_of`; `follows_from` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
60+
61+
**[1] `opentracing.ref_type`:** The causal relationship between a child Span and a parent Span.
62+
63+
---
64+
65+
`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.
66+
67+
| Value | Description | Stability |
68+
|---|---|---|
69+
| `child_of` | The parent Span depends on the child Span in some capacity | ![Development](https://img.shields.io/badge/-development-blue) |
70+
| `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) |
71+
72+
<!-- markdownlint-restore -->
73+
<!-- prettier-ignore-end -->
74+
<!-- END AUTOGENERATED TEXT -->
75+
<!-- endsemconv -->
76+
3977
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

0 commit comments

Comments
 (0)