Skip to content

[chore] Provide consistent compatibility guidance for signals #2927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+50 −61
Open

[chore] Provide consistent compatibility guidance for signals #2927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
826f4bd
Provide consistent compatability guidance for signals
thompson-tomo Oct 17, 2025
eb3709d
Formatting fixes
thompson-tomo Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/general/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ linkTitle: Events
aliases: [events-general]
--->

# Semantic conventions for events
# Event semantic conventions

**Status**: [Development][DocumentStatus]

Expand Down Expand Up @@ -36,7 +36,7 @@ the event.

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

## 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.
Expand Down
9 changes: 6 additions & 3 deletions docs/general/profiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@
linkTitle: Profiles
--->

# Profiles attributes
# Profile semantic conventions

**Status**: [Development][DocumentStatus]

<!-- toc -->

- [General profiles identification attributes](#general-profiles-identification-attributes)
- [Frame types](#frame-types)
- [Compatibility with pprof](#compatibility-with-pprof)
- [Compatibility](#compatibility)
- [Pprof](#pprof)

<!-- tocstop -->

Expand Down Expand Up @@ -60,7 +61,9 @@ They may be used in any Profiles record they apply to.
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## 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
Expand Down
54 changes: 0 additions & 54 deletions docs/general/trace-compatibility.md
View file
Open in desktop

This file was deleted.

44 changes: 42 additions & 2 deletions docs/general/trace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Trace
aliases: [trace-general]
aliases: [trace-general, trace-compatibility]
--->

# Trace semantic conventions
Expand All @@ -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.
Expand All @@ -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).

<!-- semconv opentracing -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
<!-- markdownlint-capture -->
<!-- markdownlint-disable -->

**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) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status
Loading