Skip to content

Add tornado WebSocketHandler instrumentation support #3498

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

devmonkey22
Copy link

Description

Add tornado WebSocketHandler instrumentation support. Previously, the tornado instrumentation would improperly handle tracing and metrics that would end prematurely before the websocket connection was really closed (it would end when the HTTP connection was upgraded).

Fixes #2761

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?

Added TestTornadoInstrumentation.test_websockethandler test which makes a websocket connection and ensures the traces are instrumented properly.

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

@devmonkey22 devmonkey22 requested a review from a team as a code owner May 13, 2025 03:24
@github-actions github-actions bot requested a review from shalevr May 13, 2025 03:24
response = func(*args, **kwargs)

_record_on_finish_metrics(server_histograms, handler)
try:
Copy link
Contributor

@xrmx xrmx May 21, 2025

Choose a reason for hiding this comment

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

Not sure we should catch user code exception and change the code behavior, or if we do we should re-raise later.

Copy link
Author

Choose a reason for hiding this comment

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

Its just a finally block to ensure that we finish the trace span and metrics, even if the user code raises an exception. It doesn't catch, so it shouldn't need to re-raise?

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.

Broken Tornado Intrumentation for Websocket
3 participants