Repository navigation
Conversation
83187ea to
37d54e4
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4530 +/- ##
==========================================
- Coverage 86.81% 86.81% -0.00%
==========================================
Files 525 525
Lines 20739 20736 -3
==========================================
- Hits 18003 18000 -3
Misses 2736 2736
🚀 New features to boost your workflow:
|
mateenali66
left a comment
There was a problem hiding this comment.
Ran this against the curl client with response_timeout = 1. A server that never replies fails the export at about 1s on both main and this PR, and replies at 990 to 999ms split the same way. So the change only matters for a custom client.
For that case, Export() still calls session->FinishSession() after the deadline (:495). SilentSession::FinishSession returns at once, so the test can't see it. A client built like curl waits there on the transfer (http_operation_curl.cc:523-538), so a dead worker thread still hangs Export(). curl's CancelSession() does not block (http_client_curl.cc:255-262). Should the expired path cancel instead?
The conflict is only CHANGELOG.md.
FinishSession() waits for the in-flight transfer to complete, which defeats the purpose of the response deadline for HTTP clients (e.g. curl) whose worker thread blocks on the transfer itself. Cancel the session instead when the deadline expires. Addresses review feedback from open-telemetry#4530 (review)
|
Good catch, and sorry for the delay replying. This was actually fixed same-day in Added |
mateenali66
left a comment
There was a problem hiding this comment.
No gap in the timeout path, that one holds. Built the head and swapped the silent session for one that delivers a prompt ConnectFailed. It cancels too: 0 ms elapsed, cancel called, finish not, with response_timeout at 30.
The branch is on write_successful, not on deadline expiry, so ConnectFailed, SendFailed and CreateFailed take it as well. Those record Failure promptly with the transfer already over, and for curl the two calls differ. FinishSession waits on the result future, CancelSession aborts and does not. So three paths stop reaping the transfer, which is more than the comment above the branch claims.
Pending is already the signal. A deadline expiry leaves completion_ there, every other failure sets Failure. Worth having waitForResponse report which of the two it left on?
|
Confirmed, the branch was keyed on write_successful rather than on the deadline itself. Fixed in `295ec739`: waitForResponse() now reports via an out-param whether completion_ was still Pending when the deadline passed, and only that case cancels; a terminal failure (ConnectFailed, SendFailed, CreateFailed) finishes the session normally since the transfer is already over. Added ExportFinishesSessionOnTerminalFailureInsteadOfCancelling with a FailFastSession that delivers ConnectFailed immediately, asserting FinishSession() runs and CancelSession() does not, and that the export returns well under the 30s response_timeout_. On the waitForResponse() reporting which state it left on: went with an out-param (timed_out) rather than exposing CompletionState directly, so the caller only sees the one bit it needs. Let me know if you'd rather have the full state exposed for something else. |
…a non-responding client The synchronous export path waited on its response condition variable with no deadline of its own, entirely trusting the injected HttpClient to eventually deliver a terminal event via OnResponse or OnEvent. Nothing in the HttpClient interface actually guarantees that: a client that accepts a request and never calls back (a dead thread, a reused socket, a swallowed error) left Export() blocked for the life of the process, with no way for a caller's Shutdown() to release it either. waitForResponse() now takes an absolute deadline, derived from the exporter's own configured response timeout and captured before the request is sent, so the wait is bounded independent of whether the client honors its side of the contract. A deadline that passes without a terminal event reads as failure, the same outcome a terminal error event would already produce, so no successful path changes. Added a SilentHttpClient/SilentSession test double whose SendRequest() never calls back into its handler at all, and verified the regression test actually catches the bug: reverting the fix locally makes the test hang and get killed by its own timeout wrapper (exit 124), rather than passing vacuously. Fixes open-telemetry#4362
…elated to this change)
FinishSession() waits for the in-flight transfer to complete, which defeats the purpose of the response deadline for HTTP clients (e.g. curl) whose worker thread blocks on the transfer itself. Cancel the session instead when the deadline expires. Addresses review feedback from open-telemetry#4530 (review)
The cancel-vs-finish branch was keyed on write_successful, so any terminal failure (ConnectFailed, SendFailed, CreateFailed) also took the CancelSession() path even though the transfer was already over by then. For curl, CancelSession() and FinishSession() are not interchangeable in that case. waitForResponse() now reports via an out-param whether the deadline passed with completion_ still Pending (a genuine still-outstanding transfer, which needs cancelling) as opposed to a terminal event having already arrived (which needs the normal FinishSession()). Added ExportFinishesSessionOnTerminalFailureInsteadOfCancelling with a FailFastSession/FailFastHttpClient pair that delivers ConnectFailed promptly, asserting FinishSession() is called and CancelSession() is not, and that the export returns well under the response_timeout_. Addresses review feedback from mateenali66.
295ec73 to
cdf582f
Compare
thc1006
left a comment
There was a problem hiding this comment.
Checked cdf582f5 here. 75 checks green on this one, so unlike some of its neighbours CI has actually exercised it; what follows is the part CI does not tell you.
I filed #4362, and the shape I suggested there was wrong. It was only the deadline. That on its own would have moved the hang rather than removed it, because Export() calls FinishSession() next, and in http_operation_curl.cc HttpOperation::Finish() does this:
if (async_data_ && async_data_->result_future.valid())
{
if (HttpOperationAccessor::GetThreadId(*async_data_) != std::this_thread::get_id())
{
static_cast<void>(async_data_->result_future.get());
}
}Export() is not the IO thread, so that get() blocks until the promise is set, and the promise is set from Cleanup() on the thread that never came back. The wait would have returned on time and then stopped in the same place. Abort() by contrast only raises is_aborted_ and schedules the removal. So the timed_out flag and the CancelSession() branch are the part that actually closes #4362, and the comment you put above them says exactly why. That is a correction to my issue, not to your change.
Ran the three new cases both ways, gcc 14, clean worktree:
| result | |
|---|---|
| the three cases on this head | pass, 3 runs of 3 |
| the whole Elasticsearch suite on this head | 6 of 6 |
the three cases with only main's es_log_record_exporter.cc swapped back |
ExportReturnsOnTimeoutWhenClientNeverResponds starts and never returns, killed at 120 s |
That last row is the issue: not a wrong answer, a thread that does not come back. Your case pins it rather than describing it.
One coordination note. This and my #4331 both edit waitForResponse, you the signature and me the two missing recordCompletion calls on ReadError and WriteError. git merge-tree reports a content conflict between the two branches, so whichever lands second needs a rebase. Yours is older and green; mine is the one that should move, and I will do that rebase rather than leave it to you.
Approving. The deadline is captured before SendRequest() where it should be, the Pending state reads as failure the same way a terminal error would, and the cancel is on the one path that needs it.
…ort-wait-deadline # Conflicts: # CHANGELOG.md
|
@marcalff could you please check this PR once? It already has an approval from thc1006. |
mateenali66
left a comment
There was a problem hiding this comment.
re-checked at d52dc711, both earlier points are fixed. ExportFinishesSessionOnTerminalFailureInsteadOfCancelling fails against the e2a08111 source and passes now, and the ES suite is clean under tsan and asan.
one behaviour change. response_timeout = 0 now fails every sync export. the deadline at es_log_record_exporter.cc:492 has already passed, so it cancels in 0 ms even when the server answers at once. on main 0 reaches curl as CURLOPT_TIMEOUT_MS 0, which means no timeout, so exports succeed. if 0 should keep working, applying the deadline only when the timeout is positive would do it.
also the comment at :113 says curl's own timeout normally arrives as TimedOut. curl reports it as SendFailed (#4604), and #4647 rewrites the same block, so the two PRs will conflict there.
waitForResponse()'s deadline was always derived as now() + seconds(response_timeout_), so response_timeout_ = 0 produced a deadline equal to now(), which the next instant is already behind. Every synchronous export then timed out immediately, even against a client that was about to answer successfully, since cv_::wait_until checks its predicate before checking the deadline only when the predicate is already satisfied at entry. response_timeout = 0 is documented as meaning no timeout, matching curl's own CURLOPT_TIMEOUT_MS 0 semantics, so a non-positive timeout now maps to steady_clock::time_point::max() instead. Added ZeroResponseTimeoutMeansNoTimeout with a DelayedSession that answers on a background thread after a genuine short delay, so the deadline comparison is actually exercised; confirmed it fails on the prior behavior and passes on this fix. Also corrected the waitForResponse() doc comment, which claimed a timeout surfaces as a TimedOut session event. It surfaces as SendFailed, matching the wording open-telemetry#4647 already uses for the same comment. Addresses review feedback from mateenali66.
…ort-wait-deadline # Conflicts: # CHANGELOG.md
|
Confirmed, response_timeout = 0 mapped to now() as the deadline, which is already behind the instant waitForResponse() checks it. Fixed by mapping a non-positive timeout to time_point::max() instead, matching curl's own CURLOPT_TIMEOUT_MS 0 semantics. Added ZeroResponseTimeoutMeansNoTimeout with a session that answers after a genuine short delay on a background thread, since a synchronous fake session's predicate would already be satisfied before the deadline is even checked. Confirmed it fails on the prior code and passes on the fix. Also updated the waitForResponse() comment to say SendFailed instead of TimedOut, matching the wording #4647 already uses for the same block. Good catch on the two PRs touching the same comment, whichever merges first the other will need a small rebase there. |
|
@mateenali66 pushed the fix for the response_timeout=0 case and the comment correction, could you take another look when you get a chance? |
|
re-checked at one catch with Format also wants a clang-format pass on |
|
Retraction. An earlier version of this comment claimed the timeout path can call a destroyed handler. I built the branch and it cannot. Sorry for the noise. What I missed: The ordering inside Measured on
One thing did come out of it. On the timeout path the handler takes two terminal events after The two things I checked that do hold. Merge order: no conflicts between this and my #4297, #4337 or #4502. #4331 gives one conflict, in |
Fixes #4362.
The synchronous export path waited on its response condition variable with no deadline of its own, trusting the injected
HttpClientto always eventually deliver a terminal event viaOnResponseorOnEvent. Nothing in theHttpClientinterface actually guarantees that: a client is a supported public surface, not a test seam, and one that accepts a request and never calls back (a dead thread, a reused socket, a swallowed error) leftExport()blocked for the life of the process, with no way for a caller'sShutdown()to release it either.Changes
waitForResponse()now takes an absolutestd::chrono::steady_clock::time_pointdeadline instead of waiting unconditionally, viacv_.wait_until()in place ofcv_.wait().response_timeout_and captured beforeSendRequest()is called, so it reflects this exporter's own timeout budget rather than whatever the client does with it.Pending, which reads as failure, the same outcome a terminal error event already produces today. No successful path changes.Testing
Added
SilentHttpClient/SilentSessiontest doubles whoseSendRequest()never calls back into the handler at all (noOnResponse, noOnEvent), the exact scenario the issue describes.ExportReturnsOnTimeoutWhenClientNeverRespondsconstructs the exporter with a 1 secondresponse_timeout_and this client, and assertsExport()returnskFailurerather than hanging.Verified the test actually catches the regression: reverted the fix locally (kept the test) and reran under a
timeoutwrapper, the test hung and was killed at exit code 124 instead of passing vacuously. Restored the fix and confirmed all four tests in the file pass, total runtime 1 second (the deadline in the new test), not 30 (the defaultresponse_timeout_).