log_method 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd51e1c0b040a4cc45e4d687d5d856f2e7bccec8b3abc9a7805d7e8eb3e5488e
-  data.tar.gz: 0bf8d484eb418695b4b3ce546bda78bb033124b0e9c950714cb14f90c6217815
+  metadata.gz: 8d10807c991e7f6c1eff009b0256157931c02cc3a08d16be9ea6d9f0024d9312
+  data.tar.gz: 44522431c6e794bf56295a57e4f3ef5729e47d1076d4b1f3eececb8d23a65c0d
 SHA512:
-  metadata.gz: 3c3eb39b6bdce35dc03780555480f9e2e7ac33b0c1464b35ee0e1ba6f79ea7805cd19fee8e618b4a4b8ca044e4f82029ef943d2e13c61d10deaa77e2b04d94c4
-  data.tar.gz: 74ceee8774b9f583dc0df50b341f4aa1f363672c3ad605e318ff736319e84b6375a164ceeceedbcd27e2e8f8dbf4ace63b5c3d23a1c6273107f314a57466454b
+  metadata.gz: f78bc154c16fa5a0febe3e5e0fe719ad8611acb93ae7696546acb6ea0350373b790749139e94487866d2d31a3d315c2d99d7d02da44c78dd26c6c49640089e46
+  data.tar.gz: b11ae0e3a527a99e5f1955b3f950066b0921d01c480ac178a1e467ef1af19c20cc9eb0413c47ff48f801d6deeeaae6070e3b6ed3f72b507a0a70a9a8fe025fc3

data/README.md

@@ -123,7 +123,9 @@ end
    - `trace_id` - The trace id returned by `trace_id_proc`, or `nil` if that isn't configured.
    - `current_actor_id` - The value returned by; `current_actor_proc`, or `nil` if that isn't configured.
    - `log_message` - the log message passed to `log`
-* `current_actor_id_label` - If a current actor is logged, this is the label that will precede it in the logs
+
+   You can also pass an array of proc/lambdas and all of them will be called in order given.
+* `current_actor_id_label` - If a current actor is logged, this is the label that will precede it in the logs. Default is `current_actor_id`.
 * `current_actor_proc` - Called to retrieve an identifier of the current actor executing the code, such as the current user.
 * `external_identifier_method` - If you are using external ids on your objects, this is the name of that method. If an object is passed in that responds to this method, it will be used instead of `id` when creating the log message.
 * `trace_id_proc` - returns the current request's request ID, trace ID, or cross-request ID.  This is useful to tie various log messages together that were all part of a single request.
@@ -147,6 +149,37 @@ LogMethod.config do |c|
 end
 ```
 
+It will log the method name as the breadcrumb (truncating to avoid Bugsnag's limits) and set these attributes:
+
+* `class` - The name of the class that logged the message
+* `object_id` - The id of the object passed, based on documentation above
+* `object_class` - The name of the class of the object passed
+* `trace_id` - The trace id, if configured and available
+* `current_actor_id` - The id of the current actor, if configured and available. Note that this will respect the `current_actor_id_label`, so if
+you have that set to `user_id`, `user_id` is used here instead of `current_actor_id`.
+
+#### OpenTelementry Events
+
+You can use `LogMethod::OpenTelemetryAfterLog` to send each log method as a wide event to your Open Telementry provider (e.g. Honeycomb):
+
+```ruby
+# config/initializers/log_method.rb
+require "log_method/open_telemetry_after_log"
+LogMethod.config do |c|
+  c.after_log_proc = LogMethod::OpenTelemetryAfterLog
+end
+```
+
+This will send an event whose message is the same as your log message, along with these attributes:
+
+* `log_method.class_name` - class that logged the message
+* `log_method.method_name` - method passed to `log`
+* `log_method.object_id` - object ID as described above
+* `log_method.object_class_name` - class name of the passed object
+* `app.trace_id` - trace id, if configured and available
+* `app.current_actor_id` - current actor id, if configured and available. note that if you have configured `current_actor_id_label`, that will be
+used here instead, so if if you've set it to `user_id`, this attribute will be named `app.user_id`.
+
 #### PaperTrail whodunnit
 
 The [PaperTrail gem](https://github.com/paper-trail-gem/paper_trail) has support for storing an actor or user along with versions created on

data/lib/log_method/bugsnag_after_log.rb

@@ -1,11 +1,12 @@
 class LogMethod::BugsnagAfterLog
   def self.call(class_thats_logging_name, method_name, object_id, object_class_name, trace_id, current_actor_id, _log_message)
+    current_actor_id_attribute = LogMethod.config.current_actor_id_label.to_sym
     Bugsnag.leave_breadcrumb method_name.to_s[0..29], {
       class: class_thats_logging_name,
       object_id: object_id,
       object_class: object_class_name,
       trace_id: trace_id,
-      admin_user_id: current_actor_id
+      current_actor_id_attribute => current_actor_id,
     }, Bugsnag::Breadcrumbs::LOG_BREADCRUMB_TYPE
   end
 end

data/lib/log_method/config.rb

@@ -1,6 +1,6 @@
 class LogMethod::Config
-  attr_accessor :after_log_proc,
-                :current_actor_id_label,
+  attr_reader   :after_log_procs
+  attr_accessor :current_actor_id_label,
                 :current_actor_proc,
                 :external_identifier_method,
                 :trace_id_proc
@@ -10,13 +10,17 @@ class LogMethod::Config
   end
 
   def reset!
-    @after_log_proc             = NO_OP
+    @after_log_procs            = []
     @current_actor_id_label     = "current_actor_id"
     @current_actor_proc         = NO_OP
     @external_identifier_method = nil
     @trace_id_proc              = NO_OP
   end
 
+  def after_log_proc=(proc_or_array)
+    @after_log_procs = Array(proc_or_array)
+  end
+
 private
 
   NO_OP = ->(*) {}

data/lib/log_method/log.rb

@@ -34,18 +34,19 @@ module LogMethod::Log
 
     all_args = [self.class.name, method, object_id, object_class&.name, trace_id, current_actor_id, message]
 
-    after_log_proc = LogMethod.config.after_log_proc
-    arity = if after_log_proc.kind_of?(Proc)
-              after_log_proc.arity
-            elsif after_log_proc.respond_to?(:call)
-              after_log_proc.method(:call).arity
-            end
-    args_for_arity = if arity <= 0
-                       []
-                     else
-                       all_args[0..(arity-1)]
-                     end
-    after_log_proc.(*args_for_arity)
+    LogMethod.config.after_log_procs.each do |after_log_proc|
+      arity = if after_log_proc.kind_of?(Proc)
+                after_log_proc.arity
+              elsif after_log_proc.respond_to?(:call)
+                after_log_proc.method(:call).arity
+              end
+      args_for_arity = if arity <= 0
+                         []
+                       else
+                         all_args[0..(arity-1)]
+                       end
+      after_log_proc.(*args_for_arity)
+    end
   end
 
 private

data/lib/log_method/open_telemetry_after_log.rb

@@ -0,0 +1,18 @@
+class LogMethod::OpenTelemetryAfterLog
+  def self.call(class_thats_logging_name, method_name, object_id, object_class_name, trace_id, current_actor_id, log_message)
+    current_actor_id_attribute = "app.#{LogMethod.config.current_actor_id_label}"
+
+    OpenTelemetry::Trace.current_span.add_event(
+      log_message,
+      attributes: {
+        "log_method.class_name"        => class_thats_logging_name,
+        "log_method.method_name"       => method_name,
+        "log_method.object_id"         => object_id,
+        "log_method.object_class_name" => object_class_name,
+        "app.trace_id"                 => trace_id,
+        current_actor_id_attribute     => current_actor_id,
+      }
+    )
+  end
+end
+

data/lib/log_method/version.rb

@@ -1,3 +1,3 @@
 module LogMethod
-  VERSION="1.1.0"
+  VERSION="1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_method
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dave Copeland
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -63,6 +63,7 @@ files:
 - lib/log_method/bugsnag_after_log.rb
 - lib/log_method/config.rb
 - lib/log_method/log.rb
+- lib/log_method/open_telemetry_after_log.rb
 - lib/log_method/paper_trail_current_actor.rb
 - lib/log_method/version.rb
 - log_method.gemspec