audit-log 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53d84b5630a7c9f749caa8d66d6f14de6bf98c8fd6341bb1abb552f3b9355cdc
-  data.tar.gz: 683b90bb6df772855a53e9d21c5c97f0e7ce5d12e7d933ff5931d6dd5caaeb1b
+  metadata.gz: 781905d915bbdb53e6755f91e70cf3c9263f30f7274a48c8d0118d6ff969c508
+  data.tar.gz: d8ae15f1d925905290e02b8130574580573b8b60ab189fad0116f2336966440a
 SHA512:
-  metadata.gz: a45f0115b7a154598ae5d92ae4ee34268d33757f7201f3fee155e41e084dde12016c7778b69cd1ba25597aacd47c87d1889b9cb977ca5c59e8996c130497298c
-  data.tar.gz: 6a032c5c485609ad6b85421d52b5ec3fce29bcf3d3218344a0121c26092ec94cb5904aa1af32b1eff093e9b453aa0a71e507a9b62972d1a5319a4d6410043e79
+  metadata.gz: 91f4e614279bd61db2d88f854d7f9f4e5764d519fe11e69bdad0e68a790651b5e815dadc5587514d9401297a6a93a29b4f56e48ce1528991947dfe763a158243
+  data.tar.gz: '072735568a99674de1ab2e552306f6311d31eacafff9c95fc1c6730fefb4a70c37cc27a98206a02c8b01b4b300fa3eab80ed3b6f8f828988091fff0cc41742a1'

data/README.md

@@ -1,9 +1,13 @@
 # AuditLog
 
-Trail audit logs (Operation logs) into the database for user behaviors, including a web UI to query logs.
+Trail audit logs (Operation logs) into the database for user behaviors, including a Web UI to query logs.
 
 [![Build Status](https://travis-ci.org/rails-engine/audit-log.svg?branch=master)](https://travis-ci.org/rails-engine/audit-log)
 
+> We used audit-log in our production environment more than 1 year, until now (2020.5.21), it's inserted about **20 million** log in our system.
+
+[中文介绍与使用说明](https://ruby-china.org/topics/39890)
+
 ## Demo UI
 
 Audit log list:
@@ -82,8 +86,8 @@ end
 In models or other places:
 
 ```rb
-AuditLog.audit!(:update_password, @user, payload: { ip: request.ip })
-AuditLog.audit!(:sign_in, @user, payload: { ip: request.ip })
+AuditLog.audit!(:update_password, @user, payload: { ip: request.remote_ip })
+AuditLog.audit!(:sign_in, @user, payload: { ip: request.remote_ip })
 AuditLog.audit!(:create_address, nil, payload: params)
 ```
 

data/db/migrate/20190527035005_create_audit_logs.rb

@@ -1,9 +1,11 @@
-class CreateAuditLogs < ActiveRecord::Migration[5.0]
+# frozen_string_literal: true
+
+class CreateAuditLogs < ActiveRecord::Migration[5.2]
   def change
     create_table 'audit_logs', force: :cascade do |t|
       t.string 'action', null: false
-      t.integer 'user_id'
-      t.integer 'record_id'
+      t.bigint 'user_id'
+      t.bigint 'record_id'
       t.string 'record_type'
       t.text 'payload'
       t.text 'request'

data/lib/audit-log.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require_relative './audit-log/version'
 require_relative './audit-log/configuration'
 require_relative './audit-log/model'
+require_relative './audit-log/log_subscriber'
 require_relative './audit-log/engine'
 require 'kaminari'
 
@@ -24,30 +27,35 @@ module AuditLog
     #
     # AuditLog.audit!(:edit_account, @account, payload: account_params, user: current_user)
     def audit!(action, record = nil, payload: nil, user: nil, request: nil)
-      request_info = {}
-      if request
-        request_info = {
-          ip: request.ip,
-          url: request.url,
-          user_agent: request.user_agent
-        }
-      end
+      ActiveSupport::Notifications.instrument('audit.audit_log', action: action) do
+        request_info = {}
+        if request
+          request_info = {
+            request_id: request.request_id,
+            ip: request.remote_ip,
+            url: request.url,
+            user_agent: request.user_agent
+          }
+        end
 
-      # Set nil if record is a new_record, do this for avoid create record.
-      record = nil if record&.new_record?
+        # Set nil if record is a new_record, do this for avoid create record.
+        record = nil if record&.new_record?
 
-      AuditLog::Log.create!(
-        action: action,
-        record: record,
-        payload: (payload || {}).to_h.deep_stringify_keys,
-        user: user,
-        request: request_info.deep_stringify_keys
-      )
+        Rails.logger.silence do
+          AuditLog::Log.create!(
+            action: action,
+            record: record,
+            payload: (payload || {}).to_h.deep_stringify_keys,
+            user: user,
+            request: request_info.deep_stringify_keys
+          )
+        end
+      end
     end
 
     # Get I18n action name options for select
     def action_options
-      I18n.t("audit_log.action").map { |k, v| [v, k.to_s] }
+      I18n.t('audit_log.action').map { |k, v| [v, k.to_s] }
     end
   end
 end

data/lib/audit-log/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './controller_helper'
 
 module AuditLog
@@ -7,5 +9,11 @@ module AuditLog
     ActiveSupport.on_load(:action_controller) do
       prepend AuditLog::ControllerHelper
     end
+
+    AuditLog::LogSubscriber.attach_to :audit_log
+
+    initializer 'audit-log.assets.precompile', group: :all do |app|
+      app.config.assets.precompile += %w[audit-log/application.css]
+    end
   end
 end

data/lib/audit-log/log_subscriber.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module AuditLog
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    # ActiveSupport::Notifications.instrument('audit.audit_log', action: action)
+    def audit(event)
+      prefix = color('AuditLog', CYAN)
+      action = color(event.payload[:action], BLUE)
+      debug "  #{prefix} #{action} (#{event.duration.round(1)}ms)"
+    end
+  end
+end

data/lib/audit-log/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AuditLog
-  VERSION = '0.3.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audit-log
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kaminari
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -63,7 +63,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/exception_track_manifest.js
 - app/assets/stylesheets/audit-log/application.css
 - app/controllers/audit_log/logs_controller.rb
 - app/models/audit_log/log.rb
@@ -78,6 +77,7 @@ files:
 - lib/audit-log/configuration.rb
 - lib/audit-log/controller_helper.rb
 - lib/audit-log/engine.rb
+- lib/audit-log/log_subscriber.rb
 - lib/audit-log/model.rb
 - lib/audit-log/version.rb
 - lib/generators/audit_log/install_generator.rb

data/app/assets/config/exception_track_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/audit-log.js
-//= link_directory ../stylesheets/audit-log.css