Skip to content
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

mark code.* attributes as release candidate #1599

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

mark code.* attributes as release candidate #1599

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
abc65eb
mark code.* attributes as stable
SylvainJuge Nov 20, 2024
a90a2e5
switch to release candidate
SylvainJuge Nov 21, 2024
ce699d8
add changelog
SylvainJuge Nov 21, 2024
4dde071
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
SylvainJuge Nov 21, 2024
4f5a41c
fix go version
SylvainJuge Nov 21, 2024
266d89a
2 spaces for markdown lint
SylvainJuge Nov 25, 2024
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
12 changes: 6 additions & 6 deletions model/code/registry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,38 @@ groups:
attributes:
- id: code.function
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should consider renaming it to code.function.name since there could be other things we'd eventually want to capture and we try to add specific property name to avoid ambiguity.

Are there any stable OTel components that rely on this name already?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SylvainJuge I'd recommend opening a separate PR to do any attribute names, and then coming back to this PR afterwards

type: string
stability: experimental
stability: stable
brief: >
The method or function name, or equivalent (usually rightmost part of the code unit's name).
examples: serveRequest
- id: code.namespace
type: string
stability: experimental
stability: stable
brief: >
The "namespace" within which `code.function` is defined. Usually the qualified class or module name,
such that `code.namespace` + some separator + `code.function` form a unique identifier for the code unit.
examples: com.example.MyHttpService
- id: code.filepath
type: string
stability: experimental
stability: stable
brief: >
The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
examples: /usr/local/MyApplication/content_root/app/index.php
- id: code.lineno
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to consider renaming this attribute to code.line.number to be consistent with the rest of semconv and our guidance to avoid abbreviations.

Do we know if it's already used as is in any stable components in otel?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The opentelemetry-php is stable and is known to rely on some of those attributes.

I will try to exhaustively list the impacts in the rename PR

type: int
stability: experimental
stability: stable
brief: >
The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`.
examples: 42
- id: code.column
type: int
stability: experimental
stability: stable
brief: >
The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`.
examples: 16
- id: code.stacktrace
type: string
stability: experimental
stability: stable
brief: >
A stacktrace as a string in the natural representation for the language runtime.
The representation is to be determined and documented by each language SIG.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's instead add a link to https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md#stacktrace-representation where we have it documented for each language.

Expand Down
Loading