Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-98090

SpoolEagerProducerStage should spill if allowDiskUse is specified and memory usage has exceeded some limit

    • Type: Icon: Task Task
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • Query Execution
    • QE 2025-02-03, QE 2025-02-17

      SpoolEagerProducerStage retrieves all results from its children and stores them in a buffer. It returns results reading the contents of the buffer. Currently there is no limit on the amount of memory that can be used by this buffer.

      To set the maximum allowed memory, we will use the internalQueryMaxSpoolDiskUsageBytes query knob that is already used by the classic SpoolStage.

      The stage will spill to disk when the data structure exceeds the maximum memory allowed.

      The spilling should be implemented in a method 

      void spill(unit64_t maximumMemoryUsage)

       that will spill until the memory used by the stage is at most maximumMemoryUsage. The method should track the following metrics

      • bool usedDisk : Set to true when the stage has spilled.
      • uint64_t spills : The number of times the stage spilled.
      • uint64_t spilledBytes : The size, in bytes, of the memory released with spilling.
      • uint64_t spilledDataStorageSize : The size, in bytes, of disk space used for spilling.

      We will track those metrics using the SpoolStats struct. The metrics should be reported in serverStatus and in explain execution stats.

      Before spilling, the stage should make sure that there is enough disk space for spilling. This can be done using ensureSufficientDiskSpaceForSpilling and uassertStatusOK.

      A second method, to retrieve the spilled data, should be added to allow the SpoolEagerProducerStage to execute reading data from disk. The method should make sure to keep the memory usage below the threshold at any moment.
      The stage should release all memory and disk when it is closed.

            Assignee:
            foteini.alvanaki@mongodb.com Foteini Alvanaki
            Reporter:
            foteini.alvanaki@mongodb.com Foteini Alvanaki
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: