Skip to content

Remove erroneous type attribute from asgi instrumentation#2145

Closed
samuelcolvin wants to merge 7 commits intoopen-telemetry:mainfrom
samuelcolvin:remove-asgi-type
Closed

Remove erroneous type attribute from asgi instrumentation#2145
samuelcolvin wants to merge 7 commits intoopen-telemetry:mainfrom
samuelcolvin:remove-asgi-type

Conversation

@samuelcolvin
Copy link
Copy Markdown
Contributor

@samuelcolvin samuelcolvin commented Jan 31, 2024 •
edited
Loading

Description

As per #2055 (comment) this PR removes the undocumented and non-specific attribute type from opentelemetry-instrumentation-asgi.

Fixes #2055

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • none so far...

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla bot commented Jan 31, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@samuelcolvin samuelcolvin requested a review from a team January 31, 2024 10:17
@samuelcolvin
Copy link
Copy Markdown
Contributor Author

samuelcolvin commented Jan 31, 2024

I'd also be happy to change this to use a semconv HTTP attribute, but I couldn't see one that would be appropriate.

@samuelcolvin samuelcolvin mentioned this pull request Jan 31, 2024
Closed
shalevr
shalevr reviewed Feb 4, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@shalevr shalevr left a comment

Choose a reason for hiding this comment

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

Could you remove the type attribute from the tests?
in the test_asgi_middleware.py file

opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py

Line 641 in 6c13a5e

"type": "websocket",

@samuelcolvin
Copy link
Copy Markdown
Contributor Author

samuelcolvin commented Feb 4, 2024

Will do.

@alexmojaki
Copy link
Copy Markdown
Contributor

alexmojaki commented Feb 7, 2024

How about renaming the attribute to asgi.event.type or asgi.message.type?

@samuelcolvin
Copy link
Copy Markdown
Contributor Author

samuelcolvin commented Feb 26, 2024

Okay, I've fixed tests, but on balance I think I agree with @alexmojaki that we should keep type but all it something more descriptive.

Could you remove the type attribute from the tests? in the test_asgi_middleware.py file

opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py

Line 641 in 6c13a5e

"type": "websocket",

No, that's the ASGI type in an ASGI scope, which has to be there. 🤦

@Kludex
Copy link
Copy Markdown
Member

Kludex commented Feb 26, 2024

How about renaming the attribute to asgi.event.type or asgi.message.type?

Yeah. I'd call it asgi.event.type, but message and event are used as synonymous in the ecosystem.

@samuelcolvin samuelcolvin mentioned this pull request Feb 27, 2024
Merged
11 tasks
@samuelcolvin
Copy link
Copy Markdown
Contributor Author

samuelcolvin commented Feb 27, 2024

replaced by #2300.

@samuelcolvin samuelcolvin deleted the remove-asgi-type branch February 27, 2024 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shalevr shalevr shalevr left review comments

+1 more reviewer

@srikanthccv srikanthccv srikanthccv approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

ASGI instrumentation creates a 'type' attribute

6 participants

@samuelcolvin @alexmojaki @Kludex @srikanthccv @shalevr @ocelotl