audit-log 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f260e9ba5935c19f8abc860626f55bad7143114a4d6dccc91426f1026ae5b852
-  data.tar.gz: db2c855ffaa981972cec024d3acfe551b483a6f6c60c2b3c2714ba2c21c73dee
+  metadata.gz: cd049092e7b9e427a66e776f4248c42a74b19fb667a12fec8aa5ecf9abaf08f3
+  data.tar.gz: 2d7e6e61ddf78747fbf9dbb1b2b427c16fa6c0015405eaf3222e23839afdf691
 SHA512:
-  metadata.gz: ef5227fe304be06dc55e5465c2e74c37bcb76acc475d839c3844574bccde9081a0cf83bea763aa91062faaa52e718598935aa3a2d6c5ccd85ede9f017a771843
-  data.tar.gz: f4cb4ee5dd6d482687c8fbc788f54a4c269a4d8eb50559119e65506f8df5cc439d3246bfae9e8e9456c47833cfc787dadaee3db076ca0aa274fdfd494dd706a0
+  metadata.gz: a3c21ee0a6658f309188e1fffb17c906cf0005eb0c67ed337e65f6c0ba901e17ec1238e49e796abb7bb173e70dd61385b28d7af7fcc64d8fefd8cd06c829fa82
+  data.tar.gz: 3faacb77c43e1af56395c4aa515c67e536a1a96c719baa313051bd6995aa17d949c67454a0234b3bbf35329fa0b7eecc2a29b4d13bbc0105773f2dbfef9da755

data/README.md

@@ -1,9 +1,11 @@
 # 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.
+
 ## Demo UI
 
 Audit log list:

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,31 +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 = {
-          request_id: request.request_id,
-          ip: request.remote_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
@@ -8,8 +10,10 @@ module AuditLog
       prepend AuditLog::ControllerHelper
     end
 
-    initializer "audit-log.assets.precompile", group: :all do |app|
-      app.config.assets.precompile += %w( audit-log/application.css )
+    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,5 +1,5 @@
 # frozen_string_literal: true
 
 module AuditLog
-  VERSION = '0.3.2'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audit-log
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kaminari
@@ -77,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