hubrise_initializer 0.1.3 → 0.1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a8a59da71bc03d6c9b93eb8f8f60f717b9b12ebb94db3ef2a6fd5cbd0c18f1
-  data.tar.gz: 1ce9b1f812aafdf52c58466b20e0cc3803215ae389b6ae5d29af10b5ae43a1e0
+  metadata.gz: 37e629a537e2eacaa23cf9987e2d8645c03117d1e6c4ee0c4548f7a6ecdff82c
+  data.tar.gz: f8e50daacfdb1c156031de6dde69dd929f38823a243f25f2eb0ccf03ffa224d3
 SHA512:
-  metadata.gz: 0e1c394b12b539e2135fa79ba0397aa53dad89059a16c632d1d13b2bdb7db6c0cdb301ada258722e9d6047ab911ec0af673c09c7e1cb1a680f5e191c25a63d14
-  data.tar.gz: a1480ed7d4d2d80c63ddc092535cf498ab88234599df146e0f47496f57a4225873ef4812ab60710081f6874d75df543bf02c7eb96d3163dc8fbf73a829838a48
+  metadata.gz: 1071e274a8216f2ab8438b59fed1063e760952c7202d0368f9ba205e7520cd780a6bf4d903c364e7662e63e309936d6af1c95febf332a44d18d47387a4177424
+  data.tar.gz: 6bbe481d434f6a814377d81090225ef5d08cf68d1dae10088ad7ec8579d61195cefdece286c25809ae35f9afe26ab155f130342893e9ad6a356c5b01f34bdc72

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+/.idea

data/README.md

@@ -0,0 +1,10 @@
+To upload the latest version to RubyGems.org:
+
+1. Increase version
+
+2. Build & publish (assuming the new version is `0.1.0`):
+
+```bash
+gem build hubrise_initializer
+gem push hubrise_initializer-*.gem
+``` 

data/hubrise_initializer.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |spec|
+  spec.name = 'hubrise_initializer'
+  spec.version = '0.1.3.1'
+
+  spec.require_paths = ['lib']
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.authors = ["Antoine Monnier"]
+  spec.summary = "Rails app initializers optimized for HubRise"
+  spec.homepage = "https://github.com/hubrise/rails-initializer.git"
+  spec.license = "MIT"
+
+  spec.add_runtime_dependency 'lograge', '~> 0.11'
+  spec.add_runtime_dependency 'act-fluent-logger-rails', '~> 0.5'
+  spec.add_runtime_dependency 'logstash-event', '~> 1.2'
+end

data/lib/hubrise_initializer.rb

@@ -2,101 +2,85 @@ require 'lograge'
 require 'act-fluent-logger-rails'
 
 class HubriseInitializer
-  def self.configure(config, *initializers)
-    initializers.each do |initializer|
-      case initializer
-      when :logger
-        configure_logger(config)
-      when :lograge
-        configure_lograge(config)
-      when :delayed_job_logger
-        configure_delayed_job_logger(config)
-      when :web_console
-        configure_web_console(config)
+  class << self
+    def configure(*initializers)
+      initializers.each do |initializer|
+        case initializer
+        when :logger
+          configure_logger
+        when :delayed_job_logger
+          configure_delayed_job_logger
+        when :web_console
+          configure_web_console
+        end
       end
     end
-  end
-
-  private
 
-  def self.configure_logger(config)
-    if log_level = ENV['RAILS_LOG_LEVEL']
-      config.log_level = log_level
-    end
+    private
 
-    case ENV['RAILS_LOGGER']
-    when 'stdout'
-      # Log to STDOUT (docker-compose)
-      config.logger = Logger.new(STDOUT)
+    def configure_logger
+      Rails.application.configure do
+        if log_level = ENV['RAILS_LOG_LEVEL']
+          config.log_level = log_level
+        end
 
-    when 'fluentd'
-      # Log to fluentd (kubernetes)
-      # ENV['FLUENTD_URL'] is used internally by this logger
-      config.logger = ActFluentLoggerRails::Logger.new
+        case ENV['RAILS_LOGGER']
+        when 'stdout'
+          # Log to STDOUT (docker-compose)
+          config.logger = Logger.new(STDOUT)
 
-    else
-      # Log to a file (Rails default)
-    end
-  end
+        when 'fluentd'
+          # Log to fluentd (kubernetes)
+          # ENV['FLUENTD_URL'] is used internally by this logger
+          config.logger = ActFluentLoggerRails::Logger.new
 
-  def self.configure_lograge(config)
-    case ENV['RAILS_LOGGER']
-    when 'stdout'
-      # Log to STDOUT (docker-compose)
+          config.lograge.enabled = true
+          config.lograge.formatter = ::Lograge::Formatters::Logstash.new
+          config.lograge.formatter = ::Lograge::Formatters::Json.new
 
-    when 'fluentd'
-      # Log to fluentd (kubernetes)
-      config.lograge.enabled = true
-      config.lograge.formatter = Lograge::Formatters::Logstash.new
-      config.lograge.formatter = Lograge::Formatters::Json.new
+          config.lograge.ignore_actions = ["HealthCheck::HealthCheckController#index"]
+          config.lograge.custom_options = lambda { |event| HubriseInitializer::Lograge.custom_options(event) }
+          config.lograge.custom_payload { |controller| HubriseInitializer::Lograge.custom_payload(controller) }
 
-      config.lograge.ignore_actions = ["HealthCheck::HealthCheckController#index"]
+          if ENV['RAILS_LOGRAGE_SQL'] == 'true'
+            require 'lograge/sql/extension'
+          end
 
-      config.lograge.custom_options = lambda do |event|
-        exceptions = %w(controller action format id)
-        {
-            params: event.payload[:params].except(*exceptions),
-            # payload: event.payload.inspect,
-        }
+        else
+          # Log to a file (Rails default)
+        end
       end
+    end
 
-      config.lograge.custom_payload do |controller|
-        {
-            release: ENV['RELEASE'],
-            host: controller.request.host,
-            ip: controller.request.ip,
-            user_agent: controller.request.user_agent
-        }
+    def configure_delayed_job_logger
+      Rails.application.configure do
+        case ENV['RAILS_LOGGER']
+        when 'stdout'
+          # Log to STDOUT (docker-compose)
+          Delayed::Worker.logger = Logger.new(STDOUT)
+
+        when 'fluentd'
+          # Log to fluentd (kubernetes)
+          # ENV['FLUENTD_URL'] is used internally by this logger
+          Delayed::Worker.logger = ActFluentLoggerRails::Logger.new
+
+        else
+          # Log to a file
+          Delayed::Worker.logger = Logger.new(File.join(Rails.root, 'log', 'delayed_job.log'))
+        end
       end
-    else
-      # Log to a file (Rails default)
     end
-  end
-
-  def self.configure_delayed_job_logger(config)
-    case ENV['RAILS_LOGGER']
-    when 'stdout'
-      # Log to STDOUT (docker-compose)
-      Delayed::Worker.logger = Logger.new(STDOUT)
 
-    when 'fluentd'
-      # Log to fluentd (kubernetes)
-      # ENV['FLUENTD_URL'] is used internally by this logger
-      Delayed::Worker.logger = ActFluentLoggerRails::Logger.new
+    def configure_web_console
+      Rails.application.configure do
+        # web_console is generally enabled on dev only
+        return if !config.respond_to?(:web_console)
 
-    else
-      # Log to a file
-      Delayed::Worker.logger = Logger.new(File.join(Rails.root, 'log', 'delayed_job.log'))
+        # - 172.0.0.0/8: host in docker-compose
+        # - 192.168.0.0/16: inter containers network in docker-compose
+        # - 10.244.0.0/16: pod networks in Kubernetes
+        config.web_console.whitelisted_ips = ['172.0.0.0/8', '192.168.0.0/16', '10.0.0.0/8']
+      end
     end
   end
-
-  def self.configure_web_console(config)
-    # web_console is generally enabled on dev only
-    return if !config.respond_to?(:web_console)
-
-    # - 172.0.0.0/8: host in docker-compose
-    # - 192.168.0.0/16: inter containers network in docker-compose
-    # - 10.244.0.0/16: pod networks in Kubernetes
-    config.web_console.whitelisted_ips = ['172.0.0.0/8', '192.168.0.0/16', '10.244.0.0/16']
-  end
 end

data/lib/hubrise_initializer/lograge.rb

@@ -0,0 +1,52 @@
+require_relative '../hubrise_initializer'
+
+class HubriseInitializer
+  class Lograge
+    class << self
+      def custom_options(event)
+        {}
+      end
+
+      def custom_payload(controller)
+        request, response = controller.request, controller.response
+        {
+            release: ENV['RELEASE'],
+            host: request.host,
+            ip: request.ip,
+            user_agent: request.user_agent,
+            params: request.query_string.presence
+        }.merge(
+            if ENV['RAILS_LOGRAGE_QUERY'] == 'true'
+              {
+                  request_headers: process_request_headers(request).to_s,
+                  request_body: truncate_body(request.raw_post),
+                  response_headers: response.headers.to_h.to_s,
+                  response_body: truncate_body(response.body),
+              }
+            else
+              {}
+            end
+        )
+      end
+
+      private
+
+      TRUNCATED_BODY_MAX_LENGTH = 1000
+
+      def truncate_body(s)
+        s.present? ? s.squish.truncate(TRUNCATED_BODY_MAX_LENGTH, omission: '...') : nil
+      end
+
+      def process_request_headers(request)
+        http_prefix = 'HTTP_'
+        request.headers.inject({}) do |hash, (key, value)|
+          next hash if !key.start_with?(http_prefix)
+
+          header_name = key.gsub(http_prefix, '').split('_').map(&:capitalize).join('-')
+          hash[header_name] = value
+          hash
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubrise_initializer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.3.1
 platform: ruby
 authors:
 - Antoine Monnier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -58,7 +58,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- README.md
+- hubrise_initializer.gemspec
 - lib/hubrise_initializer.rb
+- lib/hubrise_initializer/lograge.rb
 homepage: https://github.com/hubrise/rails-initializer.git
 licenses:
 - MIT