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

Improve end-to-end request ID propagation #1743

Merged
merged 16 commits into from Mar 4, 2024
Merged

Conversation

hslatman
Copy link
Member

@hslatman hslatman commented Feb 28, 2024

The CA will now propagate a request ID from the X-Request-Id header from its entrypoint all the way back to the client. The CA clients have been adjusted to generate a request ID (if not yet set) and set this on each request. When an error occurs, the request ID is read from the response header.

If `X-Request-Id` is available in an HTTP request made against the
CA server, it'll be used as the identifier for the request. This
slightly changes the existing behavior, which relied on the custom
`X-Smallstep-Id` header, but usage of that header is currently not
very widespread, and `X-Request-Id` is more generally known for
the use case `X-Smallstep-Id` is used for.

`X-Smallstep-Id` is currently still considered, but it'll only be
used if `X-Request-Id` is not set.
@github-actions github-actions bot added the needs triage Waiting for discussion / prioritization by team label Feb 28, 2024
@hslatman hslatman marked this pull request as ready for review March 1, 2024 00:08
@hslatman hslatman requested review from maraino and a team March 1, 2024 00:08
@hslatman hslatman added this to the v0.25.3 milestone Mar 1, 2024
Copy link
Contributor

@azazeal azazeal left a comment

Choose a reason for hiding this comment

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

Nitpicking here and there

internal/userid/userid.go Outdated Show resolved Hide resolved
logging/handler.go Show resolved Hide resolved
monitoring/monitoring.go Show resolved Hide resolved
test/e2e/requestid_test.go Outdated Show resolved Hide resolved
test/e2e/requestid_test.go Outdated Show resolved Hide resolved
test/e2e/requestid_test.go Outdated Show resolved Hide resolved
test/e2e/requestid_test.go Outdated Show resolved Hide resolved
internal/requestid/requestid_test.go Show resolved Hide resolved
ca/client.go Show resolved Hide resolved
authority/provisioner/webhook_test.go Outdated Show resolved Hide resolved
test/e2e/requestid_test.go Outdated Show resolved Hide resolved
@hslatman hslatman requested a review from azazeal March 4, 2024 11:13
@hslatman hslatman merged commit 10aa48c into master Mar 4, 2024
13 checks passed
@hslatman hslatman deleted the herman/improve-request-id branch March 4, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage Waiting for discussion / prioritization by team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants