dockerfile-rails 1.5.1 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1aca228134c031de432e9c059c2451da36827f11334c25498506e1dc1a5f7819
-  data.tar.gz: b661bfc9e1d9a3aafa0a10181a33927616e06162bb4ea24f960d33ff5598337c
+  metadata.gz: b14b8dc852c4d34ae6fa48251cb680e89a9c08fe81942d336d21f18418643e38
+  data.tar.gz: 3d61361b94688abd9545d59a43cb22fda5fc4ecd947353a7397ee88e5cfa0b68
 SHA512:
-  metadata.gz: b432aedcdafad7b3aea076ad4501252aa2dc51f3cd980be1e6d4761d43b57773ec76ebc862d4f9cdd8526f1d5e3cf77c5f24b48d615fe558e0055b54aabd0803
-  data.tar.gz: c20b0900280252cef4eab686b3f0b2718e99e46779504174fd4898d86ec68868607acc1cc5179d5c815334c2d911e0bd587169dfe6ca023af40e2caa743f66fc
+  metadata.gz: becc43052f96c77dc89fa920039c43151737bfd284a8b533185e7334989506b28db8c6ab87da9748712c9c52de0cb7b344ef0308992d4306fc7b47a6be0eeac6
+  data.tar.gz: 11210697f2034ea5295611f7b6548cad9e5712bdd8906e0acc083edde2e35404f51c22fb2624d8e4c087c02be7319c6f71a7f76d98f5054f85d6472012767fbc

data/README.md

@@ -46,6 +46,10 @@ bin/rails generate dockerfile
 * `--no-lock` - don't add linux platforms, set `BUNDLE_DEPLOY`, or `--frozen-lockfile`.  May be needed at times to work around a [rubygems bug](https://github.com/rubygems/rubygems/issues/6082#issuecomment-1329756343).
 * `--sudo` - install and configure sudo to enable `sudo -iu rails` access to full environment
 
+#### Error Tracking & Alerting:
+* `--rollbar` - install gem and a default initializer for [Rollbar](https://rollbar.com/#)
+* `--sentry` - install gems and a default initializer for [Sentry](https://sentry.io/welcome/)
+
 ### Add a Database:
 
 Generally the dockerfile generator will be able to determine what dependencies you

data/lib/generators/dockerfile_generator.rb

@@ -31,8 +31,10 @@ class DockerfileGenerator < Rails::Generators::Base
     "procfile" => "",
     "redis" => false,
     "registry" => "",
+    "rollbar" => false,
     "root" => false,
     "sqlite3" => false,
+    "sentry" => false,
     "sudo" => false,
     "swap" => nil,
     "variant" => "slim",
@@ -169,6 +171,12 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :sudo, type: :boolean, default: OPTION_DEFAULTS.sudo,
     desc: "Install and configure sudo to enable running as rails with full environment"
 
+  class_option :sentry, type: :boolean, default: OPTION_DEFAULTS.sentry,
+    desc: "Install gems and a default initializer for Sentry"
+
+  class_option :rollbar, type: :boolean, default: OPTION_DEFAULTS.rollbar,
+    desc: "Install gem and a default initializer for Rollbar"
+
   class_option "migrate", type: :string, default: OPTION_DEFAULTS.migrate,
     desc: "custom migration/db:prepare script"
 
@@ -282,7 +290,7 @@ class DockerfileGenerator < Rails::Generators::Base
       fly_attach_consul
     end
 
-    if File.exist?("fly.toml") && (fly_processes || !options.prepare)
+    if File.exist?("fly.toml") && (fly_processes || !options.prepare || options.swap)
       if File.stat("fly.toml").size > 0
         template "fly.toml.erb", "fly.toml"
       else
@@ -291,6 +299,14 @@ class DockerfileGenerator < Rails::Generators::Base
       end
     end
 
+    if options.sentry? && (not File.exist?("config/initializers/sentry.rb"))
+      template "sentry.rb.erb", "config/initializers/sentry.rb"
+    end
+
+    if options.rollbar? && (not File.exist?("config/initializers/rollbar.rb"))
+      template "rollbar.rb.erb", "config/initializers/rollbar.rb"
+    end
+
     if @gemfile.include?("vite_ruby")
       package = JSON.load_file("package.json")
       unless package.dig("scripts", "build")
@@ -432,6 +448,15 @@ private
       system "bundle add redis --skip-install" unless @gemfile.include? "redis"
     end
 
+    if options.sentry?
+      system "bundle add sentry-ruby --skip-install" unless @gemfile.include? "sentry-ruby"
+      system "bundle add sentry-rails --skip-install" unless @gemfile.include? "sentry-rails"
+    end
+
+    if options.rollbar?
+      system "bundle add rollbar --skip-install" unless @gemfile.include? "rollbar"
+    end
+
     # https://stackoverflow.com/questions/70500220/rails-7-ruby-3-1-loaderror-cannot-load-such-file-net-smtp/70500221#70500221
     if @gemfile.include? "mail"
       %w(net-smtp net-imap net-pop).each do |gem|
@@ -644,7 +669,7 @@ private
       repos += [
        "curl https://dl-ssl.google.com/linux/linux_signing_key.pub |",
        "  gpg --dearmor > /etc/apt/trusted.gpg.d/google-archive.gpg &&",
-       'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+       'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list'
       ]
     end
 
@@ -723,12 +748,7 @@ private
     end
 
     if options.jemalloc? && !options.fullstaq?
-      if (options.platform || Gem::Platform.local.cpu).include? "arm"
-        env["LD_PRELOAD"] = "/usr/lib/aarch64-linux-gnu/libjemalloc.so.2"
-      else
-        env["LD_PRELOAD"] = "/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
-      end
-
+      env["LD_PRELOAD"] = "libjemalloc.so.2"
       env["MALLOC_CONF"] = "dirty_decay_ms:1000,narenas:2,background_thread:true"
     end
 
@@ -1078,6 +1098,29 @@ private
       end
     end
 
+    if options.swap
+      suffixes = {
+        "kib" => 1024,
+        "k"   => 1024,
+        "kb"  => 1000,
+        "mib" => 1048576,
+        "m"   => 1048576,
+        "mb"  => 100000,
+        "gib" => 1073741824,
+        "g"   => 1073741824,
+        "gb"  => 100000000,
+      }
+
+      pattern = Regexp.new("^(\\d+)(#{suffixes.keys.join('|')})?$", "i")
+
+      match = pattern.match(options.swap.downcase)
+
+      if match
+        size = ((match[1].to_i * (suffixes[match[2]] || 1)) / 1048576.0).round
+        toml += "swap_size_mb = #{size}"
+      end
+    end
+
     toml
   end
 end

data/lib/generators/templates/_nginx.erb

@@ -3,14 +3,14 @@ RUN gem install foreman && \
 <% unless run_as_root? -%>
     sed -i 's|pid /run|pid /rails/tmp/pids|' /etc/nginx/nginx.conf && \
 <% end -%>
-    sed -i 's/access_log\s.*;/access_log \/dev\/stdout;/' /etc/nginx/nginx.conf && \
-    sed -i 's/error_log\s.*;/error_log \/dev\/stderr info;/' /etc/nginx/nginx.conf
+    sed -i 's/access_log\s.*;/access_log <% unless run_as_root? %>\/dev\/<% end %>stdout;/' /etc/nginx/nginx.conf && \
+    sed -i 's/error_log\s.*;/error_log <% unless run_as_root? %>\/dev\/<% end %>stderr info;/' /etc/nginx/nginx.conf
 
 COPY <<-"EOF" /etc/nginx/sites-available/default
 server {
   listen 3000 default_server;
   listen [::]:3000 default_server;
-  access_log /dev/stdout;
+  access_log <% unless run_as_root? %>/dev/<% end %>stdout;
 
   root /rails/public;
 
@@ -28,7 +28,7 @@ server {
 
   location @backend {
     proxy_pass http://localhost:3001;
-    proxy_set_header origin 'http://localhost:3000';
+    proxy_set_header Host $http_host;
   }
 }
 EOF

data/lib/generators/templates/_passenger.erb

@@ -10,6 +10,7 @@ server {
     passenger_pool_idle_time <%= max_idle %>;
 <% end -%>
 }
+EOF
 <% if options['max-idle'] -%>
 COPY <<-'EOF' /etc/nginx/sites-enabled/hook_detached_process
 #!/usr/bin/env ruby
@@ -18,12 +19,11 @@ processes = status[/^Processes\s*:\s*(\d*)/, 1].to_i
 system 'nginx -s stop' if processes == 0
 EOF
 <% end -%>
-EOF
 RUN echo "daemon off;" >> /etc/nginx/nginx.conf && \
-    sed -i 's/access_log\s.*;/access_log \/dev\/stdout;/' /etc/nginx/nginx.conf && \
-    sed -i 's/error_log\s.*;/error_log \/dev\/stderr info;/' /etc/nginx/nginx.conf && \
+    sed -i 's/access_log\s.*;/access_log stdout;/' /etc/nginx/nginx.conf && \
+    sed -i 's/error_log\s.*;/error_log stderr info;/' /etc/nginx/nginx.conf && \
 <% if options['max-idle'] -%>
     chmod +sx /etc/nginx/sites-enabled/hook_detached_process && \
 <% end -%>
     sed -i 's/user www-data/user rails/' /etc/nginx/nginx.conf && \
-    mkdir /var/run/passenger-instreg
+    mkdir /var/run/passenger-instreg

data/lib/generators/templates/docker-entrypoint.erb

@@ -1,6 +1,6 @@
 #!/bin/bash -e
 
-<% if options.swap -%>
+<% if options.swap && !File.exist?("fly.toml")-%>
 <% if run_as_root? or using_passenger? -%>
 <% @space = "" -%>
 <% else -%>

data/lib/generators/templates/rollbar.rb.erb

@@ -0,0 +1,73 @@
+if ENV['ROLLBAR_ENV']
+  Rollbar.configure do |config|
+    # Without configuration, Rollbar is enabled in all environments.
+    # To disable in specific environments, set config.enabled=false.
+
+    config.access_token = ENV['ROLLBAR_ACCESS_TOKEN']
+
+    # Here we'll disable in 'test':
+    if Rails.env.test?
+      config.enabled = false
+    end
+
+    # By default, Rollbar will try to call the `current_user` controller method
+    # to fetch the logged-in user object, and then call that object's `id`
+    # method to fetch this property. To customize:
+    # config.person_method = "my_current_user"
+    # config.person_id_method = "my_id"
+
+    # Additionally, you may specify the following:
+    # config.person_username_method = "username"
+    # config.person_email_method = "email"
+
+    # If you want to attach custom data to all exception and message reports,
+    # provide a lambda like the following. It should return a hash.
+    # config.custom_data_method = lambda { {:some_key => "some_value" } }
+
+    # Add exception class names to the exception_level_filters hash to
+    # change the level that exception is reported at. Note that if an exception
+    # has already been reported and logged the level will need to be changed
+    # via the rollbar interface.
+    # Valid levels: 'critical', 'error', 'warning', 'info', 'debug', 'ignore'
+    # 'ignore' will cause the exception to not be reported at all.
+    # config.exception_level_filters.merge!('MyCriticalException' => 'critical')
+    #
+    # You can also specify a callable, which will be called with the exception instance.
+    # config.exception_level_filters.merge!('MyCriticalException' => lambda { |e| 'critical' })
+
+    # Enable asynchronous reporting (uses girl_friday or Threading if girl_friday
+    # is not installed)
+    # config.use_async = true
+    # Supply your own async handler:
+    # config.async_handler = Proc.new { |payload|
+    #  Thread.new { Rollbar.process_from_async_handler(payload) }
+    # }
+
+    # Enable asynchronous reporting (using sucker_punch)
+    # config.use_sucker_punch
+
+    # Enable delayed reporting (using Sidekiq)
+    # config.use_sidekiq
+    # You can supply custom Sidekiq options:
+    # config.use_sidekiq 'queue' => 'default'
+
+    # If your application runs behind a proxy server, you can set proxy parameters here.
+    # If https_proxy is set in your environment, that will be used. Settings here have precedence.
+    # The :host key is mandatory and must include the URL scheme (e.g. 'http://'), all other fields
+    # are optional.
+    #
+    # config.proxy = {
+    #   host: 'http://some.proxy.server',
+    #   port: 80,
+    #   user: 'username_if_auth_required',
+    #   password: 'password_if_auth_required'
+    # }
+
+    # If you run your staging application instance in production environment then
+    # you'll want to override the environment reported by `Rails.env` with an
+    # environment variable like this: `ROLLBAR_ENV=staging`. This is a recommended
+    # setup for Heroku. See:
+    # https://devcenter.heroku.com/articles/deploying-to-a-custom-rails-environment
+    config.environment = ENV['ROLLBAR_ENV'].presence || Rails.env
+  end
+end

data/lib/generators/templates/sentry.rb.erb

@@ -0,0 +1,17 @@
+if ENV["SENTRY_DSN"]
+
+Sentry.init do |config|
+  config.dsn = ENV["SENTRY_DSN"]
+  config.breadcrumbs_logger = [:active_support_logger, :http_logger]
+
+  # Set traces_sample_rate to 1.0 to capture 100%
+  # of transactions for performance monitoring.
+  # We recommend adjusting this value in production.
+  config.traces_sample_rate = 1.0
+  # or
+  config.traces_sampler = lambda do |context|
+    true
+  end
+end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.3
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-01 00:00:00.000000000 Z
+date: 2023-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,8 @@ files:
 - lib/generators/templates/fly.toml.erb
 - lib/generators/templates/litefs.yml.erb
 - lib/generators/templates/node-version.erb
+- lib/generators/templates/rollbar.rb.erb
+- lib/generators/templates/sentry.rb.erb
 homepage: https://github.com/fly-apps/dockerfile-rails
 licenses:
 - MIT