Indexing and performance

    Adding new documents to an index is a multi-threaded and memory-intensive operation. Meilisearch's indexes are at the core of what makes our search engine fast, relevant, and reliable. In this article, we will go over some of the details regarding RAM consumption and multi-threading.

    RAM

    By default, our indexer uses the sysinfo Rust library to calculate a machine's total memory size. Meilisearch then adapts its behavior so indexing uses a maximum two thirds of available resources. Alternatively, you can use the --max-indexing-memory instance option to manually control the maximum amount of RAM Meilisearch can consume.

    It is important to prevent Meilisearch from using all available memory during indexing. If that happens, there are two negative consequences:

    1. Meilisearch may be killed by the OS for over-consuming RAM

    2. Search performance may decrease while the indexer is processing an update

    Memory overconsumption can still happen in two cases:

    1. When letting Meilisearch automatically set the maximum amount of memory used during indexing, sysinfo may not be able to calculate the amount of available RAM for certain OSes. Meilisearch still makes an educated estimate and adapts its behavior based on that, but crashes may still happen in this case. Follow this link for an exhaustive list of OSes supported by sysinfo

    2. Lower-end machines might struggle when processing huge datasets. Splitting your data payload into smaller batches can help in this case. For more information, consult the section below

    Multi-threading

    In machines with multi-core processors, the indexer avoids using more than half of the available processing units. For example, if your machine has twelve cores, the indexer will try to use six of them at most. This ensures Meilisearch is always ready to perform searches, even while you are updating an index.

    You can override Meilisearch's default threading limit by using the --max-indexing-threads instance option. Allowing Meilisearch to use all processor cores for indexing might negatively impact your users' search experience.

    Multi-threading is unfortunately not possible in machines with only one processor core.

    Improving indexing performance

    If you encounter performance issues during indexing, we recommend trying the following:

    [
      {
        "id": 1,
        "title": "Pride and Prejudice",
        "author": "Jane Austin",
        "genre": "romance"
      },
      {
        "id": 2,
        "title": "Le Petit Prince",
        "author": "Antoine de Saint-Exupéry",
        "genre": "adventure"
      }
    ]
    

    Memory crashes

    In some cases, the OS will interrupt Meilisearch and stop all its processes. Most of these crashes happen during indexing and are a result of a machine running out of RAM. This means your computer does not have enough memory to process your dataset.

    We are aware of this issue and actively trying to resolve it. If you are struggling with memory-related crashes, we recommend: