capun 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2acb35a4d08185c4c6dd27d8eab42b31bce4135d
-  data.tar.gz: 34d036ad99afff7c5d84a63e8bfcea1f4b36b488
+  metadata.gz: c5a8c5d54204799333f6df9f7e2e0a3a3db7976c
+  data.tar.gz: 96a37e3ffce577045a497416eccb92fa135527c1
 SHA512:
-  metadata.gz: 7d383c87c33c3bccba172ab89edc3234f466a0ad317907ff33d05c5a9fd85d41307d331e598fc2262c1586c5759e6e22a124f55dd3db230b4cd9046d058f96df
-  data.tar.gz: 4d9c3f29651201dff7f6dc1fd8134dbc6bc7a03f34d0846d070a6f01c33296a47d96c0ce175802155ffc5f1be53633f9680a0e09b69e1d5347c011f991607be8
+  metadata.gz: ec5ce547cd29cac3e77ab276adf81aecfb7a51d61b5861dc7ed9bfc25a144e9fe66699024c2823b1498151917783f157f3eb7f68f028c013d5b20e724a791ba2
+  data.tar.gz: 29d78668ae200a0c495cfa41806c1d6e0d247b1b8adfe27c04fea684fe0398f6f05840d34af3976f59767e8d23cc7125e8377076d2a179d0be1d4705659766e0

data/lib/capun/setup.rb

@@ -17,8 +17,10 @@ set :unicorn_config_path, -> { "#{shared_path}/config/unicorn.config.rb" }
 
 set :uploads, []
 set :std_uploads, [
-  #basic_authenticatable.rb
+  #figaro
   {what: "config/application.yml", where: '#{shared_path}/config/application.yml'},
+  #logstash configs
+  {what: "config/deploy/logstash.config.erb", where: '#{shared_path}/config/logstash.config'},
   #basic_authenticatable.rb
   {what: "config/deploy/basic_authenticatable.rb.erb", where: '#{release_path}/app/controllers/concerns/basic_authenticatable.rb'},
   #nginx.conf
@@ -34,6 +36,7 @@ set :std_uploads, [
 set :symlinks, []
 set :std_symlinks, [
   {what: "nginx.conf", where: '/etc/nginx/sites-enabled/#{fetch(:application)}'},
+  {what: "logstash.config", where: '/etc/logstash/conf.d/#{fetch(:application)}'},
   {what: "database.yml", where: '#{release_path}/config/database.yml'},
   {what: "application.yml", where: '#{release_path}/config/application.yml'}
 ]
@@ -92,16 +95,26 @@ namespace :deploy do
   end
 
   desc 'Restart nginx'
-  task :restart do
+  task :restart_nginx do
     on roles(:app) do
       execute :sudo, "service nginx restart"
     end
   end
 
+  desc 'Restart logstash'
+  task :restart_logstash do
+    if fetch(:addELK)
+      on roles(:app) do
+        execute :sudo, "service logstash restart"
+      end
+    end
+  end
+
 end
 
 before "deploy:updating", "deploy:make_dirs"
 after "deploy:symlink:linked_dirs", "deploy:upload"
 after "deploy:symlink:linked_dirs", "deploy:add_symlinks"
-after "deploy:publishing", "deploy:restart"
+after "deploy:publishing", "deploy:restart_nginx"
+after "deploy:publishing", "deploy:restart_logstash"
 after "deploy:publishing", "unicorn:restart"

data/lib/capun/version.rb

@@ -1,3 +1,3 @@
 module Capun
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/generators/capun/stage_generator.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'rails/generators/base'
 
 module Capun
@@ -14,6 +15,7 @@ module Capun
           @username = ask("Basic authentication username [ex.: mike]:")
           @password = ask("Basic authentication password [ex.: secret]:")
         end
+        @addELK = ask("Would you like to add ELK-compatible logging? [Y/n]").capitalize == 'Y'
       end
 
       def add_stage
@@ -40,12 +42,37 @@ module Capun
       end
 
       def add_secret
-        secret_token_does_not_exist = Thor::CoreExt::HashWithIndifferentAccess.new(::YAML::load_file("config/secrets.yml"))[singular_name].nil?
-        if secret_token_does_not_exist
-          append_to_file "config/secrets.yml", "\n#{singular_name}:\n  secret_key_base: #{SecureRandom.hex(64)}"
+        if File.exists?("config/secrets.yml")
+          secret_token_does_not_exist = Thor::CoreExt::HashWithIndifferentAccess.new(::YAML::load_file("config/secrets.yml"))[singular_name].nil?
+          if secret_token_does_not_exist
+            append_to_file "config/secrets.yml", "\n#{singular_name}:\n  secret_key_base: #{SecureRandom.hex(64)}"
+          end
         end
       end
- 
+
+      def add_ELK
+
+        if @addELK
+          #coping logstash config
+          copy_file "logstash.config.erb", "config/deploy/logstash.config.erb"
+          #installing required gems
+          gem "lograge"
+          gem "logstash-event"
+          inside Rails.root do
+            run "bundle install --quiet"
+          end
+          #adding lograge configs to relevant environment initializer
+          inject_into_file "config/environments/#{singular_name}.rb", File.read(File.expand_path("../templates/lograge_env_config.excerpt", __FILE__)), :before => /^end/
+          #adding append_info_to_payload method override to pipe required information to lograge log
+          this_line = "class ApplicationController < ActionController::Base\n"
+          inject_into_file "app/controllers/application_controller.rb", File.read(File.expand_path("../templates/append_info.excerpt", __FILE__)), :after => this_line
+          #coping logstash config
+          copy_file "lograge_initializer.rb", "config/initializers/lograge_initializer.rb"
+          #adding flag to run 'service logstash restart' during deploy
+          append_to_file "config/deploy/#{singular_name}.rb", "\nset :addELK, true"
+        end
+      end
+
     end
   end
 end

data/lib/generators/capun/templates/append_info.excerpt

@@ -0,0 +1,11 @@
+
+	def append_info_to_payload(payload)
+		super
+		#adding ip-address for payload
+		payload[:ip] = request.headers['HTTP_X_REAL_IP'] || request.remote_ip
+		#adding agent string for payload
+		payload[:agentstring] = request.headers['HTTP_USER_AGENT'] || request.user_agent
+		#adding user
+		payload[:user] = current_user unless defined? (current_user) || current_user.nil? 
+	end
+	

data/lib/generators/capun/templates/lograge_env_config.excerpt

@@ -0,0 +1,26 @@
+	
+	#enable lograge for logging
+	config.lograge.enabled = true
+	
+	#keep orginal rails log as well
+	config.lograge.keep_original_rails_log = true
+	config.lograge.logger = ActiveSupport::Logger.new "#{Rails.root}/log/lograge_#{Rails.env}.log"
+	
+	#configure lograge options
+	config.lograge.custom_options = ->(event) {
+		opts = {
+			params: event.payload[:params],
+			time:  %Q('#{event.time}'),
+			remote_ip: event.payload[:ip],
+			agent_string: event.payload[:agentstring]
+		}
+		if event.payload[:exception]
+			app_trace = Array(event.payload[:stacktrace]).reject { |el| !el.include?('alfaexperience/app') }
+			app_trace.map! { |item| item.slice(item.index("app")..-1) }
+			opts[:stacktrace] = app_trace.join('\n')
+		end
+		opts
+	}
+
+	#use logstash output as log formatter
+	config.lograge.formatter = Lograge::Formatters::Logstash.new

data/lib/generators/capun/templates/lograge_initializer.rb

@@ -0,0 +1,17 @@
+require "active_support/notifications/instrumenter"
+
+class ActiveSupport::Notifications::Instrumenter
+
+  alias_method :instrument_original, :instrument
+
+  def instrument(name, payload = {})
+    instrument_original(name, payload) do
+      begin
+        yield
+      rescue Exception => e
+        payload[:stacktrace] = e.backtrace
+        raise
+      end
+    end
+  end
+end

data/lib/generators/capun/templates/logstash.config.erb

@@ -0,0 +1,22 @@
+input {
+	file {
+		path => "/home/<%= fetch(:user) %>/apps/<%= fetch(:application) %>/shared/log/lograge_*"
+		type => "json"
+	}
+}
+filter{
+	json{
+		source => "message"
+	}
+	useragent {
+		source => "agent_string"
+	}
+	geoip {
+		source => "remote_ip"
+	}
+}
+output {
+	elasticsearch {
+		index => "<%= fetch(:application) %>"
+	}
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capun
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ivan Zamylin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,9 +128,13 @@ files:
 - lib/generators/capun/install_generator.rb
 - lib/generators/capun/stage_generator.rb
 - lib/generators/capun/templates/Capfile
+- lib/generators/capun/templates/append_info.excerpt
 - lib/generators/capun/templates/basic_authenticatable.rb.erb
 - lib/generators/capun/templates/database.yml.erb
 - lib/generators/capun/templates/deploy.rb.erb
+- lib/generators/capun/templates/lograge_env_config.excerpt
+- lib/generators/capun/templates/lograge_initializer.rb
+- lib/generators/capun/templates/logstash.config.erb
 - lib/generators/capun/templates/nginx.conf.erb
 - lib/generators/capun/templates/stage.rb.erb
 - lib/generators/capun/templates/unicorn.config.rb.erb