mark code.* attributes as release candidate #1599
Conversation
SylvainJuge
changed the title
| @@ -1,6 +1,6 @@ | |||
| module github.com/open-telemetry/opentelemetry-specification/internal/tools | |||
|
|
|||
| go 1.22 | |||
There was a problem hiding this comment.
[for reviewer] not related to this PR, but I had to change this otherwise I got toolchain not available error when trying to generate the changelog entry template.
There was a problem hiding this comment.
/cc @joaopgrassi who has the most context on this
| 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: experimental # RELEASE CANDIDATE | ||
| 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. |
There was a problem hiding this comment.
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.
| 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: experimental # RELEASE CANDIDATE | ||
| 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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
| @@ -7,38 +7,38 @@ groups: | |||
| attributes: | |||
| - id: code.function | |||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
@SylvainJuge I'd recommend opening a separate PR to do any attribute names, and then coming back to this PR afterwards
|
I support this change. A few things we should also update:
|
|
I have opened #1624 for the naming changes suggestions, it contains a list of all the repositories that would be impacted. |
Relates to #1377
Changes
Please provide a brief description of the changes here.
Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.
Merge requirement checklist
[chore]