Repository navigation
Conversation
|
|
Pull request dashboard statusWaiting on the author · refreshed 2026-10-23 20:22 UTC Respond to 1 review item (e.g. link a commit, explain why not, ask a follow-up):
Status above doesn't look right?
|
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches existing behavior, and no unresolved issues remain.
No open issues 🎉
What changed in this PR
Documents the OTLP/gRPC log exporter’s concurrency contract, addressing #9135 without changing runtime behavior.
Changes:
- Clarifies concurrency guarantees for
Export,Shutdown, andForceFlush, plus repeated shutdown behavior. - Adds a changelog entry.
| File | Description |
|---|---|
| exporters/otlp/otlplog/otlploggrpc/exporter.go | Documents concurrency and repeated shutdown guarantees. |
| CHANGELOG.md | Records the documentation update. |
Review effort: Balanced
Co-authored-by: David Ashpole <dashpole@google.com>
Yes, I will add the same documentation to otlploghttp in this PR. That includes that ForceFlush is a no op, and that Shutdown doesn't wait for or cancel in flight exports. I will update the title and description to cover both issues. |
| // Shutdown shuts down the Exporter. Calls to Export after Shutdown return | ||
| // [log.ErrExporterShutdown]. Calls to ForceFlush perform no operation. | ||
| // | ||
| // Shutdown does not wait for or cancel in-flight Export calls. |
There was a problem hiding this comment.
Shouldn't we also add this sentence in exporters/otlp/otlplog/otlploggrpc/exporter.go?
There was a problem hiding this comment.
I think the sentence fits HTTP but not gRPC as written. In gRPC, Shutdown acquires clientMu, which Export holds for the duration of the upload, so it waits for in-flight exports (it still doesn't cancel them). I think documenting that distinction in the gRPC Shutdown comment would be more accurate than copying the HTTP wording, but I'm happy to go with whichever you prefer
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #9244 +/- ##
=======================================
- Coverage 89.4% 89.4% -0.1%
=======================================
Files 345 345
Lines 22687 22687
=======================================
- Hits 20289 20288 -1
- Misses 2398 2399 +1
🚀 New features to boost your workflow:
|
Fixes #9135
Fixes #9134
Also clarify the behavior of repeated
Shutdowncalls.Documentation-only change; no behavior changes.