Troubleshooting ES|QL

This section provides some useful resource for troubleshooting ES|QL issues:

• Query logging: Log all query types, including ES|QL, with a managed data stream (recommended)
• Legacy ES|QL query log: Log ES|QL queries using the older esql.querylog settings
• Task management API: Learn how to diagnose issues like long-running queries.
• Circuit breaker settings: Learn how ES|QL uses the circuit breaker and how to configure it. For circuit breaker errors, see Circuit breaker errors.

For tips on writing efficient queries, refer to Optimize ES|QL query performance.

When filing a support case for a slow or failing ES|QL query, include the following information so the support team can investigate quickly:

• The full ES|QL query text
• The cluster version, available from GET /
• The index pattern and approximate document count
• The time range covered by the query
• The fields and field types across all indices participating in the query, available from the field capabilities API
• The took value from the response
• Any error messages
• A query log entry, if query logging is enabled