add a Parent-Request-Id header #1365
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This provides better observability for RPC call chains by having callers include their own generated requestId (if one exists) on new outbound requests. Receivers can log the `Parent-Request-Id` header value. This should allow for observing the operations that generated a request to an endpoint by following `Parent-Request-Id` pointers backwards, without needing to view observability data for the entire traceId, which may be very large.
Generate changelog in
|
mpritham
reviewed
Feb 18, 2025
tracing-api/src/main/java/com/palantir/tracing/api/TraceHttpHeaders.java
Show resolved
Hide resolved
carterkozak
reviewed
Feb 18, 2025
Comment on lines
44
to
45
| * For traces initiated with span type {@link SpanType#SERVER_INCOMING}, | ||
| * this header will be set to the requestId generated for that trace. |
There was a problem hiding this comment.
I'm having trouble parsing this sentence. Perhaps something like:
The {@code Parent-Request-Id} header represents the requestId of the caller, if present. This provides a direct causal connection between requests up a call stack. This can be an advantage over traceId which provides a broad set of data without information to understand the call pathing unless spans are sampled.
carterkozak
reviewed
Feb 18, 2025
| "defaultTraceId", | ||
| Optional.of("forUserAgent"), | ||
| "rootOperation", | ||
| SpanType.SERVER_INCOMING); |
There was a problem hiding this comment.
We can capture the requestId value here, and assert equality below rather than isNotBlank()
|
Released 6.21.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this PR
Traces created with a span type of
SERVER_INCOMINGgenerate a requestId, which is useful for observing operations on a service related to handling a particular inbound request. However, that requestId is local to the service itself, and doesn't allow for easily following RPC call chains in observability data. While the traceId does allow for this, it can sometimes be overly noisy and doesn't allow for easily tracing through RPC calls themselves.After this PR
add a Parent-Request-Id header
This provides better observability for RPC call chains by having callers include their own generated requestId (if one exists) on new outbound requests. Receivers can log the
Parent-Request-Idheader value. This should allow for observing the operations that generated a request to an endpoint by followingParent-Request-Idpointers backwards, without needing to view observability data for the entire traceId, which may be very large.==COMMIT_MSG==
add a Parent-Request-Id header
==COMMIT_MSG==
Possible downsides?
Extra header means more bytes on the wire, but should be small.