Skip to content

chore(sdk): IggyProducer docs for Rust SDK - #3989

Merged
hubcio merged 11 commits into
apache:masterfrom
haubur:chore/producer-docs
Sep 1, 2026
Merged

chore(sdk): IggyProducer docs for Rust SDK#3989
hubcio merged 11 commits into
apache:masterfrom
haubur:chore/producer-docs

Conversation

@haubur

@haubur haubur commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Which issue does this PR address?

Closes #3988

Rationale

Improving Rust SDK docs.

What changed?

Added rustdocs for the IggyProducer, Dispatcher, BackgroundConfig and Sharding.

Local Execution

  • Passed
  • Pre-commit hooks ran

AI Usage

Drafts sometimes written by AI, then usually rewritten or adapted.
AI claims checked against code in best effort.

@github-actions

Copy link
Copy Markdown

Thanks for the PR. It is labeled S-waiting-on-review and queued for review.

Slash commands (own line, regular comment) move it around the queue:

  • /ready - back to S-waiting-on-review after addressing feedback
  • /author - flip to S-waiting-on-author while you finish changes
  • /request-review @user-or-team - request a reviewer

See CONTRIBUTING.md for details.

@github-actions github-actions Bot added the S-waiting-on-review PR is waiting on a reviewer label Aug 28, 2026
@codecov

codecov Bot commented Aug 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.08%. Comparing base (f45f9dd) to head (595fa2c).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #3989      +/-   ##
============================================
- Coverage     85.15%   85.08%   -0.07%     
  Complexity     1402     1402              
============================================
  Files          1230     1230              
  Lines        181317   181408      +91     
  Branches     147611   147704      +93     
============================================
- Hits         154392   154354      -38     
- Misses        22874    22973      +99     
- Partials       4051     4081      +30     
Components Coverage Δ
Rust Core 85.99% <100.00%> (-0.08%) ⬇️
Java SDK 67.29% <ø> (ø)
C# SDK 75.47% <ø> (-0.06%) ⬇️
Python SDK 90.06% <ø> (ø)
PHP SDK 85.65% <ø> (ø)
Node SDK 96.24% <ø> (ø)
Go SDK 69.35% <ø> (+0.03%) ⬆️
Files with missing lines Coverage Δ
core/sdk/src/clients/producer.rs 68.28% <ø> (ø)
core/sdk/src/clients/producer_builder.rs 65.46% <ø> (ø)
core/sdk/src/clients/producer_dispatcher.rs 96.35% <100.00%> (+1.04%) ⬆️
core/sdk/src/clients/producer_error_callback.rs 0.00% <ø> (ø)
core/sdk/src/clients/producer_sharding.rs 96.14% <100.00%> (+0.33%) ⬆️

... and 34 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@haubur

haubur commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

/ready

@haubur
haubur force-pushed the chore/producer-docs branch from ec29607 to 24a09a0 Compare September 1, 2026 08:39
spetz
spetz previously approved these changes Sep 1, 2026
mmodzelewski
mmodzelewski previously approved these changes Sep 1, 2026
hubcio and others added 3 commits September 1, 2026 22:05
The new IggyProducer docs promised more than the code delivers:
the readiness gate starts open and is skipped without retries,
only adjacent buffered sends merge, a panic in call() itself
ends the error task, retries are not evenly spaced, and a zero
linger spins the worker. Fix those claims, name the overflow
error instead of "the former", and state the duplicate-commit
caveat once under "Retrying" with links from elsewhere.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019pqDbbzdWsPgamaKXK69y1
A shard re-armed its linger deadline from the last flush check
and polled it even with an empty buffer, so an idle shard woke
up every linger period and a zero linger spun a core. The
deadline is now armed by the first send buffered after a flush
and polled only while the buffer is non-empty, which also gives
linger its usual meaning: a window that starts with the first
buffered send.

The error task caught panics only in the future an ErrorCallback
returned. A panic in call() itself ended the task, and every
later failure was dropped without a trace. Both are now caught,
matching what the rustdoc promises.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019pqDbbzdWsPgamaKXK69y1
@hubcio
hubcio dismissed stale reviews from mmodzelewski and spetz via 595fa2c September 1, 2026 20:08
@hubcio
hubcio merged commit 4dd8772 into apache:master Sep 1, 2026
98 checks passed
@github-actions github-actions Bot removed the S-waiting-on-review PR is waiting on a reviewer label Sep 1, 2026
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.

chore(Rust SDK): IggyProducer docs

5 participants