-
Notifications
You must be signed in to change notification settings - Fork 183
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.
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
rename some code attributes #1624
Open
SylvainJuge
wants to merge
17
commits into
open-telemetry:main
Choose a base branch
from
SylvainJuge:code-rename
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+128
−47
Open
Changes from 10 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
df9f28f
rename things
SylvainJuge 556dbd4
add changelog
SylvainJuge cc9c646
update schema-next.yaml
SylvainJuge 528affe
fix changelog
SylvainJuge f86eb82
update markdown
SylvainJuge fe2bd7b
keep deprecated attributes for compatibility
SylvainJuge c15674d
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
SylvainJuge 22c0413
update schema-next post 1.29 semconv release
SylvainJuge f27d311
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
SylvainJuge 4262528
Merge branch 'main' into code-rename
lmolkova f5d4a27
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
SylvainJuge 9303339
rename code.filepath to code.file.path
SylvainJuge feb012a
Merge branch 'main' into code-rename
lmolkova 4fb9d03
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
SylvainJuge 07c6660
add missing attribute in schema next
SylvainJuge 0783448
update references to 'code.function'
SylvainJuge 4ae0d44
update more references to code.filepath
SylvainJuge File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: breaking | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: code | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: rename `code.function`, `code.lineno` and `code.column` | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [ 1377, 1599 ] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: | | ||
| `code.function` renamed to `code.function.name` | ||
| `code.lineno` renamed to `code.line.number` | ||
| `code.column` renamed to `code.column.number` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| groups: | ||
| - id: registry.code.deprecated | ||
| type: attribute_group | ||
| display_name: Deprecated Code Attributes | ||
| brief: > | ||
| These deprecated attributes provide context about source code | ||
| attributes: | ||
| - id: code.function | ||
| type: string | ||
| stability: experimental | ||
| deprecated: Replaced by `code.function.name` | ||
| brief: > | ||
| Deprecated, use `code.function.name` instead | ||
| examples: serveRequest | ||
| - id: code.lineno | ||
| type: int | ||
| stability: experimental | ||
| deprecated: Replaced by `code.line.number` | ||
| brief: > | ||
| Deprecated, use `code.line.number` instead | ||
| examples: 42 | ||
| - id: code.column | ||
| type: int | ||
| stability: experimental | ||
| deprecated: Replaced by `code.column.number` | ||
| brief: > | ||
| Deprecated, use `code.column.number` | ||
| examples: 16 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd recommend leaving this PR open until December
1211 (to give us time to raise in the meetings below)I'd like to give enough community notice, especially since we aren't planning to provide any migration plan
I will post today in #otel-semantic-conventions, #otel-specification, and #otel-maintainers slack channels
and I'll add it to next week's meeting agendas for those SIGs to make sure everyone has a chance to voice any concerns before we merge it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a general strategy to provide a migration plan when renaming attributes beyond communication ?
Once this is merged and we know it will be included in the next semconv release, I think that I can open issues in the known impacted repositories that have been listed in the description. Please 👍 or reply to this comment if you think it's the right approach and I'll create issues.
Here we deprecate existing attributes, so I think that only the repositories where deprecation warnings are not permitted opentelemetry-java-instrumentation would require to deal with that in the semconv update PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the related announcement on slack I got what "migration plan" here means: using
OTEL_SEMCONV_STABILITY_OPT_INconfiguration and keeping it compatible for a while, likely waiting for the next major release of each component before finally doing the change.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe the consensus is that
codenamespace is not used wide enough to justify the migration plan (see notes https://docs.google.com/document/d/1pdvPeKjA8v8w_fGKAN68JjWBmVJtPCpqdi9IZrd6eEo/edit?tab=t.0), so we should be good to go.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is being used.
If people have to start properly migrating these breaking changes maybe they will be less trigger happy in creating them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@brunobat are you asking to include code attribute breaking changes under a
OTEL_SEMCONV_STABILITY_OPT_INplan similar to http attribute breaking changes? thanksThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SylvainJuge probably we should (at least) include language:
to ensure that people only have to deal with a single breaking change from now until stabilization is complete
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@brunobat do you have particular examples that would be problematic here ? Most usages I've found were in producing telemetry, not on the consumption side.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@trask, I'm ok with your suggestion.
@SylvainJuge, I've only used those properties in PoCs, it's not critical if they change.
This is a matter of principle.
In a public project like this, people shouldn't assume it's not used just because it doesn't show up in a search.
Many projects and libraries outside the OpenTelemetry repository are starting to rely on semantic conventions. Breaking them frequently will put a break on adoption.