elastic/elasticsearch-py

Helpers for `bulk` method such as `async_bulk` sleep in blocking manner, preventing graceful shutdown

Open

#2,484 opened on Mar 22, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (4,060 stars) (1,206 forks)batch import
Area: HelpersCategory: Enhancementgood first issue

Description

We tried using async_bulk and async_streaming_bulk helpers to ingest data into Elasticsearch and they work great, but we've found out that they prevent our code from gracefully shutting down when CTRL+C is pressed.

Example code that sleeps: https://github.com/elastic/elasticsearch-py/blob/e1603f4f25888ca7fee03ee977abafb00d512601/elasticsearch/_async/helpers.py#L249-L251

It would be great to have a way to:

  • Either define how the sleep happens by passing sleep function into the client
  • Make Elasticsearch client internally cancel all sleeps when the client is closed

Contributor guide

Tech stack
python
Domain
backenddata
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python async programmingElasticsearch client helpers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the helpers.py file at the linked line (L249 L251) to understand the blocking sleep call. Consider implementing one of the proposed solutions: either allow passing a custom sleep function to the helpers, or make the client cancel all in progress sleeps when closed. Review the existing async helpers for bulk operations and test the fix with a simulated shutdown scenario.