Skip to content

Rewrite readiness-probe comment to be bug-agnostic#64

Open
pawelchcki wants to merge 1 commit intopc/test-hang-fixfrom
pc/probe-comment-cleanup
Open

Rewrite readiness-probe comment to be bug-agnostic#64
pawelchcki wants to merge 1 commit intopc/test-hang-fixfrom
pc/probe-comment-cleanup

Conversation

@pawelchcki
Copy link
Copy Markdown
Contributor

@pawelchcki pawelchcki commented Apr 21, 2026

The readiness-probe comment cited a specific bug in the DatadogTracing Off scope-merge path to justify using TCP over HTTP. That bug is fixed earlier in this stack, so the comment now reads as if a live bug is still in the tree.

Restate the rationale bug-agnostically: any HTTP probe runs through the module's handlers and can emit a trace into the per-test agent session; a bare TCP connect can't. This stays true regardless of future mod_datadog changes.

Copy link
Copy Markdown
Contributor Author

pawelchcki commented Apr 21, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@pawelchcki pawelchcki changed the base branch from pc/test-hang-fix to graphite-base/64 April 21, 2026 09:44
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from f8b5e63 to 79ee32d Compare April 21, 2026 09:44
@pawelchcki pawelchcki changed the base branch from graphite-base/64 to pc/test-hang-fix April 21, 2026 09:44
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from 79ee32d to 830ce2b Compare April 21, 2026 09:51
@pawelchcki pawelchcki force-pushed the pc/test-hang-fix branch 2 times, most recently from 6a34305 to 9f8d21d Compare April 21, 2026 09:55
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch 2 times, most recently from 0791740 to 546027b Compare April 21, 2026 13:45
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from 546027b to cf1d98d Compare April 21, 2026 13:52
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from cf1d98d to 74e3eec Compare April 21, 2026 14:40
@pawelchcki pawelchcki marked this pull request as ready for review April 21, 2026 17:19
@pawelchcki pawelchcki requested a review from a team as a code owner April 21, 2026 17:19
@pawelchcki pawelchcki requested review from cataphract and Copilot and removed request for a team April 21, 2026 17:19
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the integration test harness documentation to explain why readiness is probed via TCP (instead of HTTP) in a way that remains accurate even as mod_datadog internals evolve.

Changes:

  • Rewrites the readiness-probe comment to be bug-agnostic and focused on handler/trace side effects.
  • Clarifies that HTTP probes may generate traces in the per-test agent session, while raw TCP connect does not.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# Probe readiness with a bare TCP connect rather than an HTTP GET:
# HTTP probes run through mod_datadog's handlers and can emit a
# trace into the per-test agent session, contaminating assertions
# tests make about per-request trace counts. A raw TCP connect
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Minor grammar: consider adding “that” to clarify the sentence (“…can emit a trace into the per-test agent session, contaminating assertions that tests make about per-request trace counts.”).

Suggested change
# tests make about per-request trace counts. A raw TCP connect
# that tests make about per-request trace counts. A raw TCP connect

Copilot uses AI. Check for mistakes.
@datadog-official
Copy link
Copy Markdown

datadog-official Bot commented Apr 21, 2026

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 50.93% (+0.00%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 33d9e1c | Docs | Datadog PR Page | Give us feedback!

@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from c03a185 to 100093b Compare April 21, 2026 17:56
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from 100093b to 886f1c6 Compare April 21, 2026 18:27
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from 886f1c6 to 27ea853 Compare April 21, 2026 18:43
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from 27ea853 to e4163a4 Compare April 21, 2026 18:45
The previous comment explained the TCP-over-HTTP choice by citing a
specific bug in the DatadogTracing Off scope-merge path. That bug is
now fixed, so the comment reads as if a live bug is still in the tree.
Restate the rationale in terms that will still be true after further
mod_datadog changes: any HTTP probe runs through the module's handlers
and can emit a trace into the per-test agent session; a bare TCP
connect can't.
@pawelchcki pawelchcki force-pushed the pc/probe-comment-cleanup branch from e4163a4 to 33d9e1c Compare April 21, 2026 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants