Skip to content

[docs] Clarify enqueue failure behavior in exporter helper#14544

Open
bradyuan wants to merge 1 commit intoopen-telemetry:mainfrom
bradyuan:docs/exporter-queue-failure
Open

[docs] Clarify enqueue failure behavior in exporter helper#14544
bradyuan wants to merge 1 commit intoopen-telemetry:mainfrom
bradyuan:docs/exporter-queue-failure

Conversation

@bradyuan
Copy link

@bradyuan bradyuan commented Feb 8, 2026

Adds documentation clarifying that data is dropped when it cannot be enqueued
(e.g., queue at capacity or persistent storage cannot accept writes).

This happens before exporter retry logic.

Fixes #5952.

@bradyuan bradyuan requested review from a team, bogdandrutu and dmitryax as code owners February 8, 2026 01:11
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 8, 2026

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: bradyuan / name: Brad Yuan (5db91ed)

@codecov
Copy link

codecov bot commented Feb 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.86%. Comparing base (20cbfc0) to head (5db91ed).
⚠️ Report is 21 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14544      +/-   ##
==========================================
+ Coverage   91.83%   91.86%   +0.02%     
==========================================
  Files         677      677              
  Lines       42705    42777      +72     
==========================================
+ Hits        39220    39295      +75     
+ Misses       2429     2427       -2     
+ Partials     1056     1055       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- `queue_size` (default = 1000): Maximum size the queue can accept. Measured in units defined by `sizer`
- `batch`: see below.

**Failure behavior**: If data cannot be added to the sending queue, it is dropped. This occurs when the queue has reached its configured capacity or, for persistent queues, when the underlying storage cannot accept additional data (for example, due to insufficient disk space or I/O errors). Because the data is rejected before entering the queue, it does not reach the exporter retry logic. Enqueue failures are reported by the otelcol_exporter_enqueue_failed_* metrics.
Copy link
Member

Choose a reason for hiding this comment

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

This is not true when block_on_overflow is enabled. In that case data is not immediately dropped when sending queue is full, and it may be enqueued later if the queue frees up enough space before request times out

@songy23 songy23 added area:documentation Skip Changelog PRs that do not require a CHANGELOG.md entry labels Feb 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:documentation Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Explain the exporter queue failure scenario

2 participants