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

Jump to bottom

Add 'type' to all groups #2693

Merged
merged 2 commits into from
Jul 27, 2022
Merged

Add 'type' to all groups #2693

merged 2 commits into from
Jul 27, 2022

Conversation

CleanCut
Copy link
Contributor

@CleanCut CleanCut commented Jul 25, 2022 •
edited
Loading

Adds a type to every group to resolve the build tools' unsilenceable warning mentioned in open-telemetry/build-tools#109

Changes

I added a type field to every group that was missing one. Since I didn't know what value to put, I guessed resource for the ones in the resource subdirectory, and left all the rest to span since that's what they were defaulting to.

This silences the warnings and results in zero differences in generated code in my testing.

Before this change (without open-telemetry/build-tools#109 (comment))

Using default SPAN type for semantic convention 'browser' @ line 5
Using default SPAN type for semantic convention 'cloud' @ line 5
Using default SPAN type for semantic convention 'aws.ecs' @ line 5
Using default SPAN type for semantic convention 'aws.eks' @ line 5
Using default SPAN type for semantic convention 'aws.log' @ line 5
Using default SPAN type for semantic convention 'container' @ line 5
Using default SPAN type for semantic convention 'deployment' @ line 5
Using default SPAN type for semantic convention 'device' @ line 5
Using default SPAN type for semantic convention 'faas_resource' @ line 5
Using default SPAN type for semantic convention 'host' @ line 5
Using default SPAN type for semantic convention 'k8s.cluster' @ line 5
Using default SPAN type for semantic convention 'k8s.node' @ line 5
Using default SPAN type for semantic convention 'k8s.namespace' @ line 5
Using default SPAN type for semantic convention 'k8s.pod' @ line 5
Using default SPAN type for semantic convention 'k8s.container' @ line 5
Using default SPAN type for semantic convention 'k8s.replicaset' @ line 5
Using default SPAN type for semantic convention 'k8s.deployment' @ line 5
Using default SPAN type for semantic convention 'k8s.statefulset' @ line 5
Using default SPAN type for semantic convention 'k8s.daemonset' @ line 5
Using default SPAN type for semantic convention 'k8s.job' @ line 5
Using default SPAN type for semantic convention 'k8s.cronjob' @ line 5
Using default SPAN type for semantic convention 'os' @ line 5
Using default SPAN type for semantic convention 'process' @ line 5
Using default SPAN type for semantic convention 'process.runtime' @ line 5
Using default SPAN type for semantic convention 'service' @ line 5
Using default SPAN type for semantic convention 'telemetry' @ line 5
Using default SPAN type for semantic convention 'webengine_resource' @ line 5

Also before this change (with open-telemetry/build-tools#109 (comment))

Please set the type for group 'browser' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'cloud' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'aws.ecs' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'aws.eks' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'aws.log' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'container' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'deployment' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'device' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'faas_resource' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'host' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.cluster' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.node' on line 13 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.namespace' on line 29 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.pod' on line 40 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.container' on line 56 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.replicaset' on line 76 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.deployment' on line 92 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.statefulset' on line 108 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.daemonset' on line 124 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.job' on line 140 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'k8s.cronjob' on line 156 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'os' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'process' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'process.runtime' on line 73 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'service' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'telemetry' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups
Please set the type for group 'webengine_resource' on line 2 - defaulting to type 'span'. See https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/syntax.md#groups

After this change:

  • (There is no no warning output afterwards)

@CleanCut CleanCut requested review from a team July 25, 2022 21:38
@CleanCut CleanCut changed the title add 'type' to all groups Add 'type' to all groups Jul 25, 2022
@tigrannajaryan
Copy link
Member

@CleanCut can you show in the PR description what was the warning? Ideally include before and after output to make it clear what is improved.

@CleanCut
Copy link
Contributor Author

@tigrannajaryan ✅ Added. Note: There's no output afterwards (that's the whole point).

MovieStoreGuy
MovieStoreGuy approved these changes Jul 25, 2022
View reviewed changes
Copy link

@MovieStoreGuy MovieStoreGuy left a comment

Choose a reason for hiding this comment

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

These changes make sense to me, I don't see any negative impact of this.

@MovieStoreGuy
Copy link

I also ask in future that instead of a screenshot, you add just the raw text since it makes it easier to grep for logs / errors in the code.

@CleanCut
Copy link
Contributor Author

I also ask in future that instead of a screenshot, you add just the raw text since it makes it easier to grep for logs / errors in the code.

Sure thing. ✅ Adjusted.

@arminru arminru added the area:semantic-conventions Related to semantic conventions label Jul 26, 2022
arminru
arminru approved these changes Jul 26, 2022
View reviewed changes
Copy link
Member

@arminru arminru left a comment

Choose a reason for hiding this comment

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

Thank you!

joaopgrassi
joaopgrassi approved these changes Jul 26, 2022
View reviewed changes
Copy link
Member

@joaopgrassi joaopgrassi left a comment

Choose a reason for hiding this comment

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

I'm working on generating code files from the conventions for .NET and I started noticing these warnings as well. Thanks for addressing them!

@CleanCut
Copy link
Contributor Author

No problem! They've been bothering us for awhile.

@arminru arminru mentioned this pull request Jul 27, 2022
Closed
@arminru arminru added the editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. label Jul 27, 2022
@arminru arminru merged commit 431d7d5 into open-telemetry:main Jul 27, 2022
@CleanCut CleanCut deleted the add-type branch July 27, 2022 17:28
@ahayworth ahayworth mentioned this pull request Oct 7, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joaopgrassi joaopgrassi joaopgrassi approved these changes

@arminru arminru arminru approved these changes

@reyang reyang reyang approved these changes

@MovieStoreGuy MovieStoreGuy MovieStoreGuy approved these changes

Assignees

@tigrannajaryan tigrannajaryan

Labels
area:semantic-conventions Related to semantic conventions editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@CleanCut @tigrannajaryan @MovieStoreGuy @joaopgrassi @arminru @reyang