Skip to content

Commit

Permalink
[close #751] Default MALLOC_ARENA_MAX new apps
Browse files Browse the repository at this point in the history
This PR will set MALLOC_ARENA_MAX=2 by default for new Ruby apps and for any apps running on the heroku-18 stack (when released).

While we currently have [documentation on tuning the memory behavior of glibc by setting this environment variable](https://devcenter.heroku.com/articles/tuning-glibc-memory-behavior) the default does not produce good results for Ruby applications that are using threads:

- https://www.mikeperham.com/2018/04/25/taming-rails-memory-bloat/
- https://www.speedshop.co/2017/12/04/malloc-doubles-ruby-memory.html

In general most Ruby applications are memory bound and by decreasing the memory footprint of the application we can enable scaling out via more workers. Less memory might also mean a cheaper to run application, as it consumes fewer resources.

Setting this value is not entirely free. It does come with a performance trade off. For more information, see how we originally benchmarked this setting:

- https://devcenter.heroku.com/articles/testing-cedar-14-memory-use

If a customer’s application is not memory bound and would prefer slightly faster execution over the decreased memory use, they can set their MALLOC_ARENA_MAX to a higher value. The default as specified by the [linux man page](http://man7.org/linux/man-pages/man3/mallopt.3.html) is 8 times the number of cores on the system. Or they can use the 3rd party [jemalloc buildpack](https://elements.heroku.com/buildpacks/mojodna/heroku-buildpack-jemalloc).

Our documentation will be updated to reflect this change once the PR is merged and deployed.
  • Loading branch information
schneems committed Apr 30, 2018
1 parent 901f249 commit d6a8796
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 10 deletions.
2 changes: 1 addition & 1 deletion lib/language_pack/metadata.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ def initialize(cache)

def read(key)
full_key = "#{FOLDER}/#{key}"
File.read(full_key) if exists?(key)
File.read(full_key).chomp if exists?(key)
end

def exists?(key)
Expand Down
28 changes: 23 additions & 5 deletions lib/language_pack/ruby.rb
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,27 @@ def compile

private

def default_malloc_arena_max?
return true if stack_not_14_not_16?
return true if "true" == @metadata.read("default_malloc_arena_max")

if new_app?
@metadata.write("default_malloc_arena_max", "true")
return true
end

return false
end

def stack_not_14_not_16?
case stack
when "cedar-14", "heroku-16"
return false
else
return true
end
end

def warn_bundler_upgrade
old_bundler_version = @metadata.read("bundler_version").chomp if @metadata.exists?("bundler_version")

Expand Down Expand Up @@ -337,6 +358,7 @@ def setup_profiled
set_env_override "GEM_PATH", "$HOME/#{slug_vendor_base}:$GEM_PATH"
set_env_override "PATH", profiled_path.join(":")

set_env_default "MALLOC_ARENA_MAX", "2" if default_malloc_arena_max?
add_to_profiled set_default_web_concurrency if env("SENSIBLE_DEFAULTS")

if ruby_version.jruby?
Expand Down Expand Up @@ -518,11 +540,7 @@ def load_default_cache
# install libyaml into the LP to be referenced for psych compilation
# @param [String] tmpdir to store the libyaml files
def install_libyaml(dir)
case stack
when "cedar-14", "heroku-16"
else
return
end
return false if stack_not_14_not_16?

instrument 'ruby.install_libyaml' do
FileUtils.mkdir_p dir
Expand Down
4 changes: 2 additions & 2 deletions spec/hatchet/ruby_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@

describe "2.5.0" do
it "works" do
Hatchet::Runner.new("ruby_25").deploy do
# works
Hatchet::Runner.new("ruby_25").deploy do |app|
#
end
end
end
Expand Down
9 changes: 7 additions & 2 deletions spec/hatchet/upgrade_ruby_spec.rb
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
require 'spec_helper'

describe "Upgrading ruby apps" do
it "upgrades from 2.0.0 to 2.1.0", stack: :cedar do
app = Hatchet::Runner.new("default_ruby")
it "upgrades from 2.0.0 to 2.1.0" do
app = Hatchet::Runner.new("default_ruby", stack: "heroku-16")
app.setup!
app.deploy do |app|
# MALLOC_ARENA_MAX is persisted
expect(app.run('echo "MALLOC_ARENA_MAX_is=$MALLOC_ARENA_MAX"')).to match("MALLOC_ARENA_MAX_is=2")

`echo "" > Gemfile; echo "" > Gemfile.lock`
puts `env BUNDLE_GEMFILE=./Gemfile bundle install`.inspect
Expand All @@ -14,6 +16,9 @@
expect(app.output).to match("2.4.1")
expect(app.run("ruby -v")).to match("2.4.1")
expect(app.output).to match("Ruby version change detected")

# MALLOC_ARENA_MAX is persisted
expect(app.run('echo "MALLOC_ARENA_MAX_is=$MALLOC_ARENA_MAX"')).to match("MALLOC_ARENA_MAX_is=2")
end
end
end

0 comments on commit d6a8796

Please sign in to comment.