添加lograge日志配置

Author: wy-ruby

Gemfile

@@ -133,7 +133,9 @@ gem "omniauth-github"
 gem "omniauth-wechat-oauth2"
 
 # 使用JWT实现Token认证
-gem 'jwt', '~> 2.1'
+gem 'jwt'
+# 符合 JWT (JSON Web Token) 规范的认证 API
+gem 'knock'
 
 # grape 可以帮助我们快速的构建和 Rails 完美融合的 API 接口。
 gem 'grape'
@@ -163,6 +165,9 @@ gem 'graphql', '~> 1.9'
 # RPC远程过程调用
 # gem 'grpc'
 
+# 用于处理跨域资源共享（CORS）的机架中间件，这使得跨域AJAX成为可能。
+# gem 'rack-cors'
+
 # 文档工具
 # gem "sdoc", "~> 1.0.0.rc3"
 
@@ -197,6 +202,20 @@ gem "rack-attack"
 gem "bugsnag", "~> 6.12"
 gem "uniform_notifier"
 
+# URL 友好的 ID，可以把一些不想暴露的url地址中的信息给使用id替代掉。
+gem 'friendly_id'
+
+# 所见即所得编辑器
+gem 'ckeditor'
+
+# 改变 rails 默认的日志，使变得更好。更简洁且高效的显示日志内容。
+gem "lograge"
+# Logstash与Beats，Elasticsearch和Kibana一起是Elastic Stack的一部分。
+# Logstash是服务器端数据处理管道，它同时从多个源中提取数据，进行转换，然后将其发送到您喜欢的“stash”。
+gem 'logstash-event'
+
+# 状态机
+gem  'aasm'
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
@@ -219,11 +238,11 @@ group :development, :test do
   # gem 'timecop'
 
   # 生成文档工具
-  # gem 'sdoc'
+  gem 'sdoc'
 end
 
 group :development do
-  # web-console是RubyonRails应用程序的调试工具,报错的时候可以调试的。
+  # web-console是RubyonRails应用程序在浏览器上的调试工具,报错的时候可以调试的。
   gem 'web-console', '>= 3.3.0'
 
   # 监听文件变动，并你去通知修改
@@ -295,8 +314,8 @@ group :development do
   # 在日志中写入请求源信息
   gem 'active_record_query_trace'
 
-  # 在应用的每个页面底部显示请求信息，并链接到源码（可通过 TextMate 打开）；
-  # gem 'rails-footnotes', '~> 4.0'
+  # 给你的MacOS的发送通知消息
+  # gem 'terminal-notifier'
 end
 
 group :test do

Gemfile.lock

@@ -1,6 +1,8 @@
 GEM
   remote: https://gems.ruby-china.com/
   specs:
+    aasm (5.0.8)
+      concurrent-ruby (~> 1.0)
     actioncable (5.2.4.2)
       actionpack (= 5.2.4.2)
       nio4r (~> 2.0)
@@ -111,6 +113,8 @@ GEM
       xpath (~> 3.2)
     childprocess (3.0.0)
     chronic (0.10.2)
+    ckeditor (5.1.0)
+      orm_adapter (~> 0.5.0)
     code_analyzer (0.5.1)
       sexp_processor
     coderay (1.1.2)
@@ -200,6 +204,8 @@ GEM
     flog (4.2.1)
       ruby_parser (~> 3.1, > 3.1.0)
       sexp_processor (~> 4.4)
+    friendly_id (5.3.0)
+      activerecord (>= 4.0.0)
     get_process_mem (0.2.5)
       ffi (~> 1.0)
     globalid (0.4.2)
@@ -238,7 +244,11 @@ GEM
     jbuilder (2.10.0)
       activesupport (>= 5.0.0)
     json (2.3.0)
-    jwt (2.2.1)
+    jwt (1.5.6)
+    knock (2.1.1)
+      bcrypt (~> 3.1)
+      jwt (~> 1.5)
+      rails (>= 4.2)
     launchy (2.5.0)
       addressable (~> 2.7)
     letter_opener (1.7.0)
@@ -247,6 +257,12 @@ GEM
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
+    lograge (0.11.2)
+      actionpack (>= 4)
+      activesupport (>= 4)
+      railties (>= 4)
+      request_store (~> 1.0)
+    logstash-event (1.2.02)
     loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -346,8 +362,6 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-footnotes (4.1.8)
-      rails (>= 3.2)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
     rails-i18n (5.0.4)
@@ -373,6 +387,7 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    rdoc (6.2.1)
     redis (4.0.3)
     redis-actionpack (5.2.0)
       actionpack (>= 5, < 7)
@@ -401,6 +416,8 @@ GEM
       ruby_parser (~> 3.3)
       sexp_processor
     regexp_parser (1.7.0)
+    request_store (1.5.0)
+      rack (>= 1.4)
     require_all (3.0.0)
     responders (3.0.0)
       actionpack (>= 5.0)
@@ -487,6 +504,8 @@ GEM
       sprockets (> 3.0)
       sprockets-rails
       tilt
+    sdoc (1.1.0)
+      rdoc (>= 5.0)
     seed-fu (2.3.9)
       activerecord (>= 3.1)
       activesupport (>= 3.1)
@@ -569,6 +588,7 @@ PLATFORMS
   x86_64-darwin-17
 
 DEPENDENCIES
+  aasm
   active_record_query_trace
   annotate
   bcrypt (~> 3.1.7)
@@ -587,6 +607,7 @@ DEPENDENCIES
   capistrano-sidekiq
   capistrano3-puma
   capybara (>= 2.15)
+  ckeditor
   coffee-rails (~> 4.2)
   database_cleaner
   derailed
@@ -596,6 +617,7 @@ DEPENDENCIES
   factory_bot_rails
   faker
   figaro
+  friendly_id
   grape
   grape-entity
   grape-swagger
@@ -607,10 +629,13 @@ DEPENDENCIES
   hiredis (~> 0.6.1)
   i18n
   jbuilder (~> 2.5)
-  jwt (~> 2.1)
+  jwt
+  knock
   launchy
   letter_opener
   listen (>= 3.0.5, < 3.2)
+  lograge
+  logstash-event
   meta_request
   mysql2
   omniauth
@@ -625,7 +650,6 @@ DEPENDENCIES
   rack-attack
   rack-contrib
   rails (~> 5.2.0)
-  rails-footnotes (~> 4.0)
   rails-i18n (~> 5.0.3)
   rails_best_practices
   redis (~> 4.0.2)
@@ -647,6 +671,7 @@ DEPENDENCIES
   rubycritic
   rvm1-capistrano3
   sass-rails (~> 5.0)
+  sdoc
   seed-fu
   selenium-webdriver
   sidekiq

Rakefile

@@ -4,3 +4,24 @@
 require_relative 'config/application'
 
 Rails.application.load_tasks
+
+# 用来配置 rdoc 用来生成文档。
+# 执行 rails rerdoc 就可以生成了，文档将会到 配置项中设置的 rdoc_dir 目录。
+# 访问可以直接找到对应的文件夹，直接在浏览器中打开index.html文件进行访问。也可以直接根目录下访问 doc/index.html
+require "sdoc"
+require "rdoc/task"
+
+rdoc_files = %w[
+  README.md
+  app/models
+  app/controllers
+  app/helpers
+]
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "public/doc"
+  rdoc.generator = "sdoc"
+  rdoc.template = "rails"
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include(*rdoc_files)
+end

app/controllers/application_controller.rb

@@ -65,6 +65,17 @@ def extract_locale_from_header
     # 参考：https://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/locale.rb
   end
 
+  # 定义日志中要额外添加保存的信息，信息放在 event.payload 的哈希中，可以在 config/environments/* 配置中添加的 custom_options 选项获取。
+  def append_info_to_payload(payload)
+    super
+    payload[:host] = request.host
+  end
+
+  # 处理不存在的路由信息。
+  def route_not_found
+    render file: 'public/404', status: 404
+  end
+
   private
 
     # 自定义全局用户无权限操作的时候的处理方法

config/environments/development.rb

@@ -119,4 +119,43 @@
   # devise这个gem的配置，注意不同的环境配置内容是不同的。
   config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
 
+  # 配置 lograge 的支持。一般是在生产环境下配置的。日志是保存在 #{Rails.env}.log 中。
+  config.lograge.enabled = true
+  # 可以添加自定义内容。
+  config.lograge.custom_options = lambda do |event|
+    { time: Time.now.strftime("%Y-%m-%d %H:%M:%S"), host: event.payload[:host]}
+  end
+  # 可以添加一个钩子以直接访问控制器方法（例如request和current_user）。 该哈希将自动合并到日志数据中。
+  config.lograge.custom_payload do |controller|
+    {
+        protocol: controller.request.protocol.match(/([a-zA-Z]*)/)[0].to_s
+    }
+  end
+  # 保持rails原本的日志信息
+  # config.lograge.keep_original_rails_log = true
+  # config.lograge.logger = ActiveSupport::Logger.new "#{Rails.root}/log/lograge_#{Rails.env}.log"
+
+  # 为了进一步清理日志，您还可以告诉Lograge跳过满足给定条件的日志消息。您可以跳过某些控制器操作生成的日志消息，也可以编写自定义处理程序以根据
+  # 日志事件中的数据跳过消息：
+  # config.lograge.ignore_actions = ['HomeController#index', 'AController#an_action']
+  # config.lograge.ignore_custom = lambda do |event|
+  #   return true here if you want to ignore based on the event
+  # end
+
+  # Lograge支持多种输出格式。 最常见的是上述默认Lograge键值格式。 另外，您还可以生成Logstash使用的json_event格式的JSON日志。
+  # 使用logstash输出时，需要添加  gem logstash-event
+  config.lograge.formatter = Lograge::Formatters::Logstash.new
+  # 可用的日志格式有：
+  # Lograge::Formatters::Lines.new
+  # Lograge::Formatters::Cee.new
+  # Lograge::Formatters::Graylog2.new
+  # Lograge::Formatters::KeyValue.new  # lograge 的默认格式
+  # Lograge::Formatters::Json.new
+  # Lograge::Formatters::Logstash.new
+  # Lograge::Formatters::LTSV.new
+  # Lograge::Formatters::Raw.new       # 返回一个ruby的哈希对象
+  # 除了格式化程序，您还可以通过传递一个响应#call的对象来自己操作数据：
+  # config.lograge.formatter = ->(data) { "Called #{data[:controller]}" } # data is a ruby hash
+
+
 end

config/environments/production.rb

@@ -153,4 +153,42 @@
       enable_starttls_auto: true  }
 
 
+  # 配置 lograge 的支持。一般是在生产环境下配置的。
+  config.lograge.enabled = true
+  # 可以添加自定义内容。
+  config.lograge.custom_options = lambda do |event|
+    { time: Time.now.strftime("%Y-%m-%d %H:%M:%S"), host: event.payload[:host]}
+  end
+  # 可以添加一个钩子以直接访问控制器方法（例如request和current_user）。 该哈希将自动合并到日志数据中。
+  config.lograge.custom_payload do |controller|
+    {
+        protocol: controller.request.protocol.match(/([a-zA-Z]*)/)[0].to_s
+    }
+  end
+  # 保持rails原本的日志信息
+  # config.lograge.keep_original_rails_log = true
+  # config.lograge.logger = ActiveSupport::Logger.new "#{Rails.root}/log/lograge_#{Rails.env}.log"
+
+  # 为了进一步清理日志，您还可以告诉Lograge跳过满足给定条件的日志消息。您可以跳过某些控制器操作生成的日志消息，也可以编写自定义处理程序以根据
+  # 日志事件中的数据跳过消息：
+  # config.lograge.ignore_actions = ['HomeController#index', 'AController#an_action']
+  # config.lograge.ignore_custom = lambda do |event|
+  #   return true here if you want to ignore based on the event
+  # end
+
+  # Lograge支持多种输出格式。 最常见的是上述默认Lograge键值格式。 另外，您还可以生成Logstash使用的json_event格式的JSON日志。
+  # 使用logstash输出时，需要添加  gem logstash-event
+  # config.lograge.formatter = Lograge::Formatters::Logstash.new
+  #
+  # 可用的日志格式有：
+  # Lograge::Formatters::Lines.new
+  # Lograge::Formatters::Cee.new
+  # Lograge::Formatters::Graylog2.new
+  # Lograge::Formatters::KeyValue.new  # lograge 的默认格式
+  # Lograge::Formatters::Json.new
+  # Lograge::Formatters::Logstash.new
+  # Lograge::Formatters::LTSV.new
+  # Lograge::Formatters::Raw.new       # 返回一个ruby的哈希对象
+  # 除了格式化程序，您还可以通过传递一个响应#call的对象来自己操作数据：
+  # config.lograge.formatter = ->(data) { "Called #{data[:controller]}" } # data is a ruby hash
 end

config/routes.rb

@@ -70,6 +70,10 @@
 
   # get "/auth/:action/callback", :controller => "authentications", :constraints => { :action => /wechat|github/ }
   # get "/auth/:provider/callback" => "authentications#github"
+
+  # 匹配未定义的路由到 application下的route_not_found 方法中。
+  get '*unmatched_route', to: 'application#route_not_found'
+
   # sidekiq的路由相关开始
   # 注意该路由(/sidekiq/stats)可以看到json格式sidekiq的一些状态信息。
   require 'sidekiq/web'