From 8068bbd9dc691a768c482fd5dac0c71262cc1ad2 Mon Sep 17 00:00:00 2001 From: Joe Reuter Date: Thu, 19 Sep 2019 08:38:25 +0200 Subject: [PATCH] document heap size configuration (#45625) --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a7cbff44ab931..d2f2023c2d1d24 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -173,6 +173,10 @@ yarn kbn bootstrap (You can also run `yarn kbn` to see the other available commands. For more info about this tool, see https://github.com/elastic/kibana/tree/master/packages/kbn-pm.) +#### Increase node.js heap size + +Kibana is a big project and for some commands it can happen that the process hits the default heap limit and crashes with an out-of-memory error. If you run into this problem, you can increase maximum heap size by setting the `--max_old_space_size` option on the command line. To set the limit for all commands, simply add the following line to your shell config: `export NODE_OPTIONS="--max_old_space_size=2048"`. + ### Running Elasticsearch Locally There are a few options when it comes to running Elasticsearch locally: