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

broaden the requestTrace attachment accessor #1297

Merged
merged 4 commits into from
Oct 2, 2024

Conversation

carterkozak
Copy link
Contributor

@carterkozak carterkozak commented Sep 30, 2024

==COMMIT_MSG==
broaden the requestTrace attachment accessor
==COMMIT_MSG==

This allows us to pull the attachment value from one of the many types which wrap an HttpServerExchange and delegate to its attachments, for example WebSocketHttpExchange (not Attachable) and ServerSentEventConnection (Attachable).

@changelog-app
Copy link

changelog-app bot commented Sep 30, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

broaden the requestTrace attachment accessor

Check the box to generate changelog(s)

  • Generate changelog entry

@carterkozak carterkozak force-pushed the ckozak/broaden_requestTrace_accessor branch from 59eae9c to 6ca1d0f Compare September 30, 2024 19:53
Comment on lines +46 to +48
@SuppressWarnings("unchecked")
public static final AttachmentKey<Detached> REQUEST_DETACHED_TRACE =
(AttachmentKey<Detached>) (AttachmentKey<?>) REQUEST_SPAN;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't love exposing this directly since it allows the attachment to be removed, and we don't really expect anyone to do that. The risk is small, and this unblocks applying tracing to some additional libraries without consuming that functionality directly into tracing-undertow. In particular WebSocketHttpExchange wraps an HttpServerExchange and exposes its attachments, but doesn't implement Attachable or expose the underlying exchange directly.

@bulldozer-bot bulldozer-bot bot merged commit 3540576 into develop Oct 2, 2024
5 checks passed
@bulldozer-bot bulldozer-bot bot deleted the ckozak/broaden_requestTrace_accessor branch October 2, 2024 15:41
@autorelease3
Copy link

autorelease3 bot commented Oct 2, 2024

Released 6.20.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants