Update ES exporter docs #11017
Open
Update ES exporter docs #11017
+32
−31
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
theletterf
added
skip-changelog
backport-active-all
Contributor
🔍 Preview links for changed docs |
vishaangelova
previously approved these changes
Nov 5, 2025
Contributor
vishaangelova
left a comment
vishaangelova
left a comment
There was a problem hiding this comment.
Nice! Just a couple of suggestions for your consideration
docs/reference/edot-collector/components/elasticsearchexporter.md
Outdated
Show resolved
Hide resolved
docs/reference/edot-collector/components/elasticsearchexporter.md
Outdated
Show resolved
Hide resolved
docs/reference/edot-collector/components/elasticsearchexporter.md
Outdated
Show resolved
Hide resolved
docs/reference/edot-collector/components/elasticsearchexporter.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Visha Angelova <[email protected]>
vishaangelova
previously approved these changes
Nov 5, 2025
carsonip
reviewed
Nov 5, 2025
|
|
||
| :::{note} | ||
| The `flush::interval` config is ignored when `batcher::enabled` config is explicitly set to true or false. | ||
| The `flush::interval` config is ignored when using `sending_queue` (enabled by default) or when `batcher::enabled` config is explicitly set. |
Member
There was a problem hiding this comment.
this statement is either correct or incorrect depending on which version we're on, but this line doesn't have applies_to
Contributor
Author
There was a problem hiding this comment.
Which version would it be true for?
Comment on lines
136
to
152
| The {{es}} exporter supports the common `sending_queue` settings, which enable both queuing and batching. The default sending queue is configured to do async batching with the following configuration: | ||
|
|
||
| ```yaml | ||
| sending_queue: | ||
| enabled: true | ||
| num_consumers: runtime.NumCPU() | ||
| queue_size: <based on queue.mem.events> | ||
| block_on_overflow: true | ||
| wait_for_result: true | ||
| batch: | ||
| flush_timeout: 10s | ||
| min_size: 0 | ||
| max_size: <based on flush::bytes> | ||
| sizer: items | ||
| ``` | ||
| ### Internal batching (default) | ||
| By default, the exporter performs its own buffering and batching, as configured through the `flush` setting, unless the `sending_queue::batch` or the `batcher` settings are defined. In that case, batching is controlled by either of the two settings, depending on the version. | ||
|
|
||
| ### Custom batching | ||
| The default configurations are chosen to be closer to the defaults with the exporter's previous built-in batching feature. For more details on the `sending_queue` settings, refer to the [`exporterhelper` documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md). |
Member
There was a problem hiding this comment.
i'm afraid these need to be in a applies_to 9.3
Contributor
Author
There was a problem hiding this comment.
All the default configs? If that's the case, we could put the PR on hold till 9.3 is up.
| min_size: 1000 | ||
| max_size: 10000 | ||
| timeout: 5s | ||
| flush_timeout: 5s |
lahsivjar
reviewed
Nov 5, 2025
docs/reference/edot-collector/components/elasticsearchexporter.md
Outdated
Show resolved
Hide resolved
docs/reference/edot-collector/components/elasticsearchexporter.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Vishal Raj <[email protected]>
lahsivjar
reviewed
Nov 6, 2025
| :::{applies-item} stack: ga 9.0, deprecated 9.2 | ||
| ### Deprecated batcher configuration | ||
| ```{applies_to} | ||
| stack: ga 9.0, deprecated 9.2 |
Contributor
There was a problem hiding this comment.
FYI, batcher is now removed from the config. Do we add something here for this for the 9.3 version to signal that batcher is no longer there?
Contributor
Author
|
@carsonip @lahsivjar PTAL |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the ES exporter docs based on the 0.138.0 changes.
Created using Cursor 2 on auto model rotation. I provided the latest ES Exporter README to the LLM to update the docs, then made some light edits.