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

Provide an API to access the detached trace associated with an exchange #1287

Merged
merged 4 commits into from
Sep 19, 2024
Merged

Provide an API to access the detached trace associated with an exchange #1287

merged 4 commits into from
Sep 19, 2024

Conversation

carterkozak
Copy link
Contributor

@carterkozak carterkozak commented Sep 19, 2024 •
edited
Loading

==COMMIT_MSG==
Provide an API to access the detached trace associated with an exchange
==COMMIT_MSG==

Alternative to #1288 which provides more direct access to the underlying Detached tracing exchange attachment. Uses can be more obvious as they interact directly with tracing.

@changelog-app
Copy link

changelog-app bot commented Sep 19, 2024 •
edited by carterkozak
Loading

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

Provide an API to access the detached trace associated with an exchange

Check the box to generate changelog(s)

  • Generate changelog entry

@carterkozak carterkozak mentioned this pull request Sep 19, 2024
Closed
@carterkozak carterkozak marked this pull request as ready for review September 19, 2024 16:31
@carterkozak
Test the requestTrace accessor
8419999 
it's a pretty simple getter, and the resulting object intentionally
doesn't expose state, so a nullness test is about all that really
makes sense.
bjlaub
bjlaub reviewed Sep 19, 2024
View reviewed changes
tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracingAttachments.java
@@ -27,5 +31,17 @@ public final class TracingAttachments {
/** Attachment providing the request identifier. */
public static final AttachmentKey<String> REQUEST_ID = AttachmentKey.create(String.class);

/**
* Detached span object representing the entire request including asynchronous components.
* This is intentionally not public, we expose only the {@link Detached} component which critically does not
Copy link
Contributor

Choose a reason for hiding this comment

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

we expose only the {@link Detached} component which critically does not
* include {@link DetachedSpan#complete()} APIs

I assume this is important so that the caller can only observe the span, not inadvertently call complete() which is handled by the exchange completion handler?

Copy link
Contributor Author

@carterkozak carterkozak Sep 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Yep, the idea is that when we create this span, we register the exchange completion listener to close it -- we don't want user code to inadvertently close the span before the request has a chance to complete. This object can be used to create new child spans, which themselves may be closed at the users discretion.

bjlaub
bjlaub approved these changes Sep 19, 2024
View reviewed changes
Copy link
Contributor

@bjlaub bjlaub left a comment

Choose a reason for hiding this comment

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

lgtm

@bulldozer-bot bulldozer-bot bot merged commit f479d1d into develop Sep 19, 2024
5 checks passed
@bulldozer-bot bulldozer-bot bot deleted the ckozak/expose_detached branch September 19, 2024 17:45
@autorelease3
Copy link

autorelease3 bot commented Sep 19, 2024

Released 6.19.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjlaub bjlaub bjlaub approved these changes

@mpritham mpritham Awaiting requested review from mpritham

Assignees
No one assigned
Labels
autorelease merge when ready
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@carterkozak @bjlaub @svc-changelog