Skip to content

Document synonyms filter circuit breaker behavior (ES 9.4 / serverless) #5586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 2 commits into from
Closed

Document synonyms filter circuit breaker behavior (ES 9.4 / serverless) #5586

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54dd9d4
Initial plan
Copilot Mar 23, 2026
9e58832
Document synonyms filter circuit breaker behavior
Copilot Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions solutions/search/full-text/search-with-synonyms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,19 @@ An index with invalid synonym rules cannot be reopened, making it inoperable whe
* A node restart occurs (which reopens the node assigned shards)
::::

::::{warning}
{applies_to}`stack: ga 9.4` {applies_to}`serverless: ga`

{{es}} applies a real memory circuit breaker check when building the synonyms map to prevent out-of-memory errors. The circuit breaker triggers when JVM heap memory usage exceeds 95%.

When the circuit breaker is triggered, behavior depends on the filter's `lenient` parameter:

* If `lenient` is `true`, an empty synonyms map is used and the event is logged in the {{es}} logs.
* If `lenient` is `false` (the default), the affected index enters a red state.

In ECH and self-managed deployments, the circuit breaker limit is configurable using the [`indices.breaker.total.limit`](elasticsearch://reference/elasticsearch/configuration-reference/circuit-breaker-settings.md) cluster setting. In serverless, circuit breaker limits are not configurable.
::::

## Step 3: Test your analyzer [synonyms-test-analyzer]

You can test an analyzer configuration without modifying your index settings. Use the [analyze API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze) to test your analyzer chain:
Expand Down