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.

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

erlang process.runtime attributes: remove TODO note and update descriptions #1445

Merged

Conversation

tsloughter
Copy link
Member

No real change here, simply removes the TODO since it is done and updates the attributes into a table.

Related issue: open-telemetry/opentelemetry-erlang#96

Copy link
Member

@yurishkuro yurishkuro left a comment

Choose a reason for hiding this comment

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

Does Erland SDK populate these already?

@tsloughter
Copy link
Member Author

I don't know what the semantic convention failure is about. Are docs on this in the repo?

@tsloughter
Copy link
Member Author

@yurishkuro in the latest main branch, yes.

@tsloughter
Copy link
Member Author

This reminded me to update the spec matrix, so I've now included that in this PR as well.

| Name | `process.runtime.name` | `process.runtime.version` | `process.runtime.description` |
| --- | --- | --- | --- |
| beam | BEAM | 11.0.3 | Erlang/OTP 24 erts-11.0.3 |
<!-- semconv process.runtime -->
Copy link
Member

Choose a reason for hiding this comment

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

This would add the same table as above when running the semantic conventions generator tool. Since this table is maintained manually, you'll have to remove those markers or the build fails. Currently it's complaining about a mismatch with the (potentially) generated files. See how it's done with the other tables below.

| Name | `process.runtime.name` | `process.runtime.version` | `process.runtime.description` |
| --- | --- | --- | --- |
| beam | BEAM | 11.0.3 | Erlang/OTP 24 erts-11.0.3 |
<!-- semconv process.runtime -->
Copy link
Member

Choose a reason for hiding this comment

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

@tsloughter
Copy link
Member Author

Ah, woops, thanks @arminru and @SergeyKanzhelev :). I had copied from the earlier table in the document without thinking, should be fixed now.

| Name | `process.runtime.name` | `process.runtime.version` | `process.runtime.description` |
| --- | --- | --- | --- |
| beam | BEAM | 11.0.3 | Erlang/OTP 24 erts-11.0.3 |
| Attribute | Type | Description | Examples | Required |
Copy link
Member

@Oberon00 Oberon00 Feb 17, 2021

Choose a reason for hiding this comment

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

To be consistent with other languages, I would keep the list form, as in the removed text.

Copy link
Member

@Oberon00 Oberon00 Feb 19, 2021

Choose a reason for hiding this comment

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

Looking at it again, this even repeats the Type and Required column. I think this is rather misleading. Please either:

  1. Revert to the list notation as above, just remove the TODO, maybe add a table with examples (as for other runtimes like Java) if you have more than one; or
  2. remove the Type and Required columns from the table.

Copy link
Member

@bogdandrutu bogdandrutu left a comment

Choose a reason for hiding this comment

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

Please resolve conflicts

| Name | `process.runtime.name` | `process.runtime.version` | `process.runtime.description` |
| --- | --- | --- | --- |
| beam | BEAM | 11.0.3 | Erlang/OTP 24 erts-11.0.3 |
| Attribute | Type | Description | Examples | Required |
Copy link
Member

@Oberon00 Oberon00 Feb 19, 2021

Choose a reason for hiding this comment

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

Looking at it again, this even repeats the Type and Required column. I think this is rather misleading. Please either:

  1. Revert to the list notation as above, just remove the TODO, maybe add a table with examples (as for other runtimes like Java) if you have more than one; or
  2. remove the Type and Required columns from the table.

@tsloughter
Copy link
Member Author

Switched it back to a list and merged the spec matrix with the latest in main.

Copy link
Member

@Oberon00 Oberon00 left a comment

Choose a reason for hiding this comment

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

OK, but you might want to keep the example somehow.

@tsloughter
Copy link
Member Author

Ok, added an example table.

@SergeyKanzhelev SergeyKanzhelev merged commit 85f3fb6 into open-telemetry:main Feb 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants