Skip to content

feat: enable logging of github request ID - #601

Merged
bulldozer-bot[bot] merged 1 commit into
palantir:developfrom
dblinkhorn:dblinkhorn/log-github-request-id
Aug 11, 2026
Merged

feat: enable logging of github request ID#601
bulldozer-bot[bot] merged 1 commit into
palantir:developfrom
dblinkhorn:dblinkhorn/log-github-request-id

Conversation

@dblinkhorn

Copy link
Copy Markdown
Contributor

Before this PR

Structured github_request logs do not include GitHub’s request ID, making it more difficult to diagnose failures involving the GitHub API.

After this PR

==COMMIT_MSG==
GitHub request IDs are now included in GitHub client logs.
==COMMIT_MSG==

Possible downsides?

More verbose logs?

This PR originated out of this discussion.

@changelog-app

changelog-app Bot commented Aug 6, 2026

Copy link
Copy Markdown

Generate changelog in changelog/@unreleased

Type (Select exactly one)

  • Feature (Adding new functionality)
  • Improvement (Improving existing functionality)
  • Fix (Fixing an issue with existing functionality)
  • Break (Creating a new major version by breaking public APIs)
  • Deprecation (Removing functionality in a non-breaking way)
  • Migration (Automatically moving data/functionality to a new system)

Description

Include GitHub request IDs in client request logs

Check the box to generate changelog(s)

  • Generate changelog entry

@changelog-app

changelog-app Bot commented Aug 7, 2026

Copy link
Copy Markdown

Successfully generated changelog entry!

Need to regenerate?

Simply interact with the changelog bot comment again to regenerate these entries.


📋Changelog Preview

💡 Improvements

  • Include GitHub request IDs in client request logs (#601)

Int("status", res.StatusCode)
if requestID := res.Header.Get(httpHeaderRequestID); requestID != "" {
evt.Str("github_request_id", requestID)
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think its probably friendly to always log this, but that being said similar to logging the rate limit info we may want to gate this info in an option to allow users who are sensitive to log volume to opt in or out. I'm happy to merge as is though

@bulldozer-bot
bulldozer-bot Bot merged commit 1f4a4b1 into palantir:develop Aug 11, 2026
6 checks passed
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.

2 participants