Fix circuit breaker leak in MultiTerms aggregation #79362

iverase · 2021-10-18T13:48:34Z

The MultiTermsAggregator creates a BytesKeyedBucketOrds that never gets closed and therefore it might leak the memory allocated into the circuit breaker.

elasticmachine · 2021-10-18T13:48:38Z

Pinging @elastic/es-analytics-geo (Team:Analytics)

DaveCTurner

LGTM in the sense that (1) the tests fail iff the fix is reverted and (2) the script I had to reproduce the problem no longer exhibits a leak.

DELETE /test

# 200 OK
# {
#   "acknowledged": true
# }

PUT /test
{
  "mappings": {
    "properties": {
      "field1": {
        "type": "keyword"
      },
      "field2": {
        "type": "keyword"
      }
    }
  },
  "settings": {
    "number_of_shards": 1,
    "number_of_replicas": 0
  }
}

# 200 OK
# {
#   "shards_acknowledged": true,
#   "acknowledged": true,
#   "index": "test"
# }

POST /test/_bulk
{"index":{}}
{"field1":"aaa","field2":"bb"}
{"index":{}}
{"field1":"aaa","field2":"cc"}
{"index":{}}
{"field1":"aaa","field2":"dd"}
{"index":{}}
{"field1":"aaa","field2":"ee"}
{"index":{}}
{"field1":"aaa","field2":"ff"}
{"index":{}}
{"field1":"aaa","field2":"gg"}
{"index":{}}
{"field1":"aaa","field2":"hh"}
{"index":{}}
{"field1":"aaa","field2":"jj"}
{"index":{}}
{"field1":"aaa","field2":"kk"}
{"index":{}}
{"field1":"aaa","field2":"ll"}

# 200 OK
# {
#   "took": 87,
#   "items": [
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "PR50k3wBIyZAxwBsvzs1",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 0
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "Ph50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 1
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "Px50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 2
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "QB50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 3
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "QR50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 4
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "Qh50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 5
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "Qx50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 6
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "RB50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 7
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "RR50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 8
#       }
#     },
#     {
#       "index": {
#         "status": 201,
#         "_type": "_doc",
#         "_primary_term": 1,
#         "_id": "Rh50k3wBIyZAxwBsvzs3",
#         "_shards": {
#           "successful": 1,
#           "total": 1,
#           "failed": 0
#         },
#         "_index": "test",
#         "result": "created",
#         "_version": 1,
#         "_seq_no": 9
#       }
#     }
#   ],
#   "errors": false
# }

POST /test/_refresh

# 200 OK
# {
#   "_shards": {
#     "successful": 1,
#     "total": 1,
#     "failed": 0
#   }
# }

GET /_nodes/stats/breaker?filter_path=nodes.*.breakers.request

# 200 OK
# {
#   "nodes": {
#     "zKIBvy-7QpKw-Lizpwi0vA": {
#       "breakers": {
#         "request": {
#           "estimated_size": "0b",
#           "overhead": 1.0,
#           "estimated_size_in_bytes": 0,
#           "limit_size": "614.3mb",
#           "tripped": 0,
#           "limit_size_in_bytes": 644245094
#         }
#       }
#     }
#   }
# }

POST /_cache/clear

# 200 OK
# {
#   "_shards": {
#     "successful": 1,
#     "total": 1,
#     "failed": 0
#   }
# }

GET /test/_search
{
  "size": 0,
  "aggs": {
    "test": {
      "multi_terms": {
        "size": 1,
        "terms": [
          {
            "field": "field1"
          },
          {
            "field": "field2"
          }
        ]
      }
    }
  }
}

# 200 OK
# {
#   "aggregations": {
#     "test": {
#       "buckets": [
#         {
#           "doc_count": 1,
#           "key_as_string": "aaa|bb",
#           "key": [
#             "aaa",
#             "bb"
#           ]
#         }
#       ],
#       "doc_count_error_upper_bound": 0,
#       "sum_other_doc_count": 9
#     }
#   },
#   "took": 26,
#   "_shards": {
#     "skipped": 0,
#     "successful": 1,
#     "total": 1,
#     "failed": 0
#   },
#   "timed_out": false,
#   "hits": {
#     "max_score": null,
#     "total": {
#       "value": 10,
#       "relation": "eq"
#     },
#     "hits": []
#   }
# }

GET /_nodes/stats/breaker?filter_path=nodes.*.breakers.request

# 200 OK
# {
#   "nodes": {
#     "zKIBvy-7QpKw-Lizpwi0vA": {
#       "breakers": {
#         "request": {
#           "estimated_size": "744b",
#           "overhead": 1.0,
#           "estimated_size_in_bytes": 744,
#           "limit_size": "614.3mb",
#           "tripped": 0,
#           "limit_size_in_bytes": 644245094
#         }
#       }
#     }
#   }
# }

POST /_cache/clear

# 200 OK
# {
#   "_shards": {
#     "successful": 1,
#     "total": 1,
#     "failed": 0
#   }
# }

GET /test/_search
{
  "size": 0,
  "aggs": {
    "test": {
      "multi_terms": {
        "size": 1,
        "terms": [
          {
            "field": "field1"
          },
          {
            "field": "field2"
          }
        ]
      }
    }
  }
}

# 200 OK
# {
#   "aggregations": {
#     "test": {
#       "buckets": [
#         {
#           "doc_count": 1,
#           "key_as_string": "aaa|bb",
#           "key": [
#             "aaa",
#             "bb"
#           ]
#         }
#       ],
#       "doc_count_error_upper_bound": 0,
#       "sum_other_doc_count": 9
#     }
#   },
#   "took": 3,
#   "_shards": {
#     "skipped": 0,
#     "successful": 1,
#     "total": 1,
#     "failed": 0
#   },
#   "timed_out": false,
#   "hits": {
#     "max_score": null,
#     "total": {
#       "value": 10,
#       "relation": "eq"
#     },
#     "hits": []
#   }
# }

GET /_nodes/stats/breaker?filter_path=nodes.*.breakers.request

# 200 OK
# {
#   "nodes": {
#     "zKIBvy-7QpKw-Lizpwi0vA": {
#       "breakers": {
#         "request": {
#           "estimated_size": "1.4kb",
#           "overhead": 1.0,
#           "estimated_size_in_bytes": 1488,
#           "limit_size": "614.3mb",
#           "tripped": 0,
#           "limit_size_in_bytes": 644245094
#         }
#       }
#     }
#   }
# }

Leaving it to Igor for a final look tho, this isn't code which which I'm familiar.

nik9000

👍

I do think it'd be good to randomize whether or not we pre-allocate AggregatorTestCase. I'll bet we'd have caught this earlier if we did that.

iverase · 2021-10-18T15:27:58Z

@nik9000 I added logic in AggregatorTestCase to randomise preallocation.

nik9000 · 2021-10-18T16:04:14Z

test/framework/src/main/java/org/elasticsearch/search/aggregations/AggregatorTestCase.java

@@ -471,7 +471,7 @@ protected ScriptService getMockScriptService() {
            indexSettings,
            query,
            breakerService,
-            builder.bytesToPreallocate(),
+            randomBoolean() ? 0 : builder.bytesToPreallocate(),


nik9000 · 2021-10-18T16:04:51Z

...l/src/main/java/org/elasticsearch/xpack/ml/aggs/categorization/CategorizeTextAggregator.java

@@ -105,7 +105,7 @@ protected CategorizeTextAggregator(
    @Override
    protected void doClose() {
        super.doClose();
-        Releasables.close(this.analyzer, this.bytesRefHash);
+        Releasables.close(this.analyzer, this.bytesRefHash, bucketOrds);


@benwtrent looks like you had a leak that I didn't catch. I'm quite thankful for leak detecting test cases.

benwtrent

Thank you for fixing CategorizeTextAggregator.java as well!

imotov

Great catch! Thanks!

iverase · 2021-10-18T20:33:57Z

@elasticmachine update branch

iverase · 2021-10-19T05:16:04Z

@elasticmachine run elasticsearch-ci/part-1

The MultiTermsAggregator creates a BytesKeyedBucketOrds that never gets closed and therefore it might leak the memory allocated into the circuit breaker.

elasticsearchmachine · 2021-10-19T05:58:49Z

💔 Backport failed

Status	Branch	Result
✅	7.x
❌	7.15	Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 79362

The MultiTermsAggregator creates a BytesKeyedBucketOrds that never gets closed and therefore it might leak the memory allocated into the circuit breaker.

* upstream/master: (34 commits) Add extensionName() to security extension (elastic#79329) More robust and consistent allowAll indicesAccessControl (elastic#79415) Fix circuit breaker leak in MultiTerms aggregation (elastic#79362) guard geoline aggregation from parents aggegator that emit empty buckets (elastic#79129) Vector tiles: increase the size of the envelope used to clip geometries (elastic#79030) Revert "[ML] Add queue_capacity setting to start deployment API (elastic#79369)" (elastic#79374) Convert token service license object to LicensedFeature (elastic#79284) [TEST] Fix ShardPathTests for MDP (elastic#79393) Fix fleet search API with no checkpints (elastic#79400) Reduce BWC version for transient settings (elastic#79396) EQL: Rename a test class for eclipse (elastic#79254) Use search_coordination threadpool in field caps (elastic#79378) Use query param instead of a system property for opting in for new cluster health response code (elastic#79351) Add new kNN search endpoint (elastic#79013) Disable BWC tests Convert auditing license object to LicensedFeature (elastic#79280) Update BWC versions after backport of elastic#78551 Enable InstantiatingObjectParser to pass context as a first argument (elastic#79206) Move xcontent filtering tests (elastic#79298) Update links to Fleet/Agent docs (elastic#79303) ...

…9421) The MultiTermsAggregator creates a BytesKeyedBucketOrds that never gets closed and therefore it might leak the memory allocated into the circuit breaker.

The MultiTermsAggregator creates a BytesKeyedBucketOrds that never gets closed and therefore it might leak the memory allocated into the circuit breaker.

Fix circuit breaker leak in MultiTerms aggregation

6622e8a

iverase added >bug :Analytics/Geo Indexing, search aggregations of geo points and shapes v8.0.0 v7.16.0 v7.15.2 labels Oct 18, 2021

iverase requested review from imotov and DaveCTurner October 18, 2021 13:48

elasticmachine added the Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) label Oct 18, 2021

DaveCTurner reviewed Oct 18, 2021

View reviewed changes

nik9000 approved these changes Oct 18, 2021

View reviewed changes

randomize preallocation in AggregatorTestCase

d44e140

fix CategorizeTextAggregator

1c38e6e

nik9000 reviewed Oct 18, 2021

View reviewed changes

nik9000 approved these changes Oct 18, 2021

View reviewed changes

missed an array

0324e02

benwtrent approved these changes Oct 18, 2021

View reviewed changes

imotov approved these changes Oct 18, 2021

View reviewed changes

Merge branch 'master' into fixLeakMultiTerms

a565043

iverase merged commit 3151198 into elastic:master Oct 19, 2021

iverase deleted the fixLeakMultiTerms branch October 19, 2021 05:57

iverase added the auto-backport Automatically create backport pull requests when merged label Oct 19, 2021

iverase mentioned this pull request Oct 19, 2021

[7.x] Fix circuit breaker leak in MultiTerms aggregation (#79362) #79421

Merged

iverase mentioned this pull request Oct 19, 2021

Fix circuit breaker leak in MultiTerms aggregation (#79362) #79422

Merged

jakelandis added v8.0.0-beta1 and removed v8.0.0 labels Oct 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix circuit breaker leak in MultiTerms aggregation #79362

Fix circuit breaker leak in MultiTerms aggregation #79362

iverase commented Oct 18, 2021

elasticmachine commented Oct 18, 2021

DaveCTurner left a comment

nik9000 left a comment

iverase commented Oct 18, 2021

nik9000 Oct 18, 2021

nik9000 Oct 18, 2021

benwtrent left a comment

imotov left a comment

iverase commented Oct 18, 2021

iverase commented Oct 19, 2021

elasticsearchmachine commented Oct 19, 2021

Fix circuit breaker leak in MultiTerms aggregation #79362

Fix circuit breaker leak in MultiTerms aggregation #79362

Conversation

iverase commented Oct 18, 2021

elasticmachine commented Oct 18, 2021

DaveCTurner left a comment

Choose a reason for hiding this comment

nik9000 left a comment

Choose a reason for hiding this comment

iverase commented Oct 18, 2021

nik9000 Oct 18, 2021

Choose a reason for hiding this comment

nik9000 Oct 18, 2021

Choose a reason for hiding this comment

benwtrent left a comment

Choose a reason for hiding this comment

imotov left a comment

Choose a reason for hiding this comment

iverase commented Oct 18, 2021

iverase commented Oct 19, 2021

elasticsearchmachine commented Oct 19, 2021

💔 Backport failed