lumberjack_data_dog_device 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c74e54590298ee33cfbb9d042360094f58277417e7ce3827fd3c65d26a0f0d
-  data.tar.gz: 772bed3d6c5f1908b9929e55dae07479ae02ce04942cd515b6c587cc1792b044
+  metadata.gz: 5dc89bac640c1450fe612caa49767cc803423030e16cee302387c00466996a0f
+  data.tar.gz: 27947af281577cee4c4b0ca72d7aa033fd8ea13b79c076f2308baf19565b16a1
 SHA512:
-  metadata.gz: f542690e1f9b8ad79c0673d59ab4fbf42f6733e98fda5f4845c00aad05fbb5da2a7b8db67bd19452a5b31269d48cafe015733539669527bd05e6cfc65fe4e3b7
-  data.tar.gz: 760efdee4a408fa4b52c123a0da1f7daee2a123c657c75cf145770e19959e1e62e734d902aa54dfb86deeb5dfa926d69ab50b2d244fdace2c5b4833a35a4e8ee
+  metadata.gz: e2826f6ad6233b10c5ecc2578de5cf0968f86d749c1b3db03ba061c1848fbfa9c2c480126e024d50a24d1d293e895fcede3c61fc1f872570f23e177f6a84e161
+  data.tar.gz: 155ad680ada842234fcc9dad6dd5fa697022120586987fc0a7644c2cf6e1e49425783d1f75b6a133f28b358a771e88fc560c1e86fbabfba338c6217d8a593e92

data/CHANGE_LOG.md

@@ -1,3 +1,8 @@
+# 1.0.1
+
+* Format non-hashes in log messages as strings to prevent stack overflow on objects that cannot be serialized to JSON.
+* Add option max_message_length to limit the length of message payload.
+
 # 1.0.0
 
 * Initial release

data/README.md

@@ -23,6 +23,8 @@ This gem provides a logging device that produces JSON output that matches the st
 
 This device extends from [`Lumberjack::JsonDevice`](). It is not tied to Data Dog in any way other than that it is opinionated about how to map and format some log tags. It can be used with other services or pipelines without issue.
 
+You can optionally specify a maximum message length with the `max_message_length` option on the device. Doing so will trucate the message payload to keep it under this number of characters. This option is provided because JSON payloads get messed up and cannot be parsed if they get too big.
+
 ## Example
 
 You could log an HTTP request to some of the DataDog standard fields like this:

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/lumberjack_data_dog_device.rb

@@ -10,9 +10,9 @@ module Lumberjack
   class DataDogDevice < JsonDevice
 
     module ExceptionHash
-      
+
       protected
-      
+
       def exception_hash(exception, device)
         hash = {"kind" => exception.class.name}
         hash["message"] = exception.message unless exception.message.nil?
@@ -24,23 +24,32 @@ module Lumberjack
         hash
       end
     end
-    
+
     # Formatter to format a messge as an error if it is an exception.
     class MessageExceptionFormatter
       include ExceptionHash
-      
+
       def initialize(device = nil)
         @device = device
       end
-      
+
       def call(object)
         if object.is_a?(Exception)
           {
             "message" => object.inspect,
             "error" => exception_hash(object, @device)
           }
-        else
+        elsif object.is_a?(Hash)
           { "message" => object }
+        elsif object.nil?
+          { "message" => nil }
+        else
+          message = object.to_s
+          max_message_length = @device.max_message_length
+          if max_message_length && message.length > max_message_length
+            message = message[0, max_message_length]
+          end
+          { "message" => message }
         end
       end
     end
@@ -124,14 +133,19 @@ module Lumberjack
     # One use for it is to keep stack traces clean and prevent them from overflowing the limit on
     # the payload size for an individual log entry.
     attr_accessor :backtrace_cleaner
-    
-    def initialize(stream_or_device, backtrace_cleaner: nil)
+
+    # You can specify a limit on the message size. Messages over this size will be split into multiple
+    # log entries to prevent overflowing the limit on message size which makes the log entries unparseable.
+    attr_accessor :max_message_length
+
+    def initialize(stream_or_device, backtrace_cleaner: nil, max_message_length: nil)
       super(stream_or_device, mapping: data_dog_mapping)
       self.backtrace_cleaner = backtrace_cleaner
+      self.max_message_length = max_message_length
     end
-    
+
     private
-    
+
     def data_dog_mapping
       {
         time: "timestamp",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_data_dog_device
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lumberjack_json_device