trailer 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ef9d938575a0cbb5572d94c31a83abb9defb0457a8da5490f3d32125816521f
-  data.tar.gz: 01010af54861f7127fc144e4970d00a1356081f564d59c161fd0289148224c62
+  metadata.gz: '080993ef6144050d45a1c16f07593acdfa29c99fd8b9a6bf5166e7bcabecd336'
+  data.tar.gz: '09e3d367d1246daa91c7acfca32d37d2863ab7f758d5956f948c0f067ce3d9aa'
 SHA512:
-  metadata.gz: 276bbfbf9e53b96c3460b902976a290845afc5e8b5b1d595d4af13537497a4bef5b0e33b0413d7c622079e8b504e350b88e9dafb9c3940b280bcfad46b34501c
-  data.tar.gz: d774b1e6d66dbeff66de86a677624e6a8e94f1edfd9b468854f1c1621f1751d011c01123982d47b29b26d0a472c5bd38e1ad2736ad15ea92f6005c82420cf770
+  metadata.gz: 789c1083fedc2c1c04972d0f96c35126768ac92203460da24e2fc0734144f36af708028a87db03bfe3921a583e67a28c10695c97f5f598572035e63a53ea63cf
+  data.tar.gz: e93b1ad62ea77c1247ab07d27d9b324b27dd44be65515ee84eaca663bfc57e13b78c4a8bb368e0b172fcdc872da8889c5aef97f28f0ac555371c211b40f98982

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.1.5 - 2020-09-08
+
+### Features
+
+* Attach all known data to exceptions. ([#3])
+* Add tests. ([#2])
+
+[#3]: https://github.com/shuttlerock/trailer/pull/3
+[#2]: https://github.com/shuttlerock/trailer/pull/2
+
 ## 0.1.4 - 2020-08-27
 
 ### Features

data/README.md

@@ -1,3 +1,6 @@
+[![CircleCI](https://circleci.com/gh/Shuttlerock/trailer/tree/master.svg?style=shield)](https://circleci.com/gh/Shuttlerock/workflows/trailer/tree/master)
+[![Gem Version](https://badge.fury.io/rb/trailer.svg)](https://badge.fury.io/rb/trailer)
+
 # Trailer
 
 Trailer provides a Ruby framework for tracing events in the context of a request or background job. It allows you to tag and log events with metadata, so that you can search later for e.g. all events and exceptions related to a particular request.

data/lib/trailer/concern.rb

@@ -14,11 +14,12 @@ module Trailer
     def trace_event(event, resource = nil, **tags, &block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       return yield block unless Trailer.enabled?
 
-      event = Trailer::Utility.resource_name(event) unless event.is_a?(String)
+      event = Trailer::Utility.resource_name(event) unless event.is_a?(String) || event.is_a?(Symbol)
 
       unless resource.nil?
-        resource_name   = resource if resource.is_a?(String)
+        resource_name   = resource if resource.is_a?(String) || resource.is_a?(Symbol)
         resource_name ||= Trailer::Utility.resource_name(resource)
+        resource_name ||= 'unknown'
 
         # If column_names() is available, we are probably looking at an ActiveRecord instance.
         if resource.class.respond_to?(:column_names)
@@ -27,8 +28,8 @@ module Trailer
           end
         elsif resource.respond_to?(:to_h)
           # This handles other types of data, such as GraphQL input objects.
-          resource.to_h.stringify_keys.each do |key, value|
-            tags[key] ||= value if key.to_s.match?(Trailer.config.auto_tag_fields) || Trailer.config.tag_fields.include?(key)
+          resource.to_h.transform_keys(&:to_sym).each do |key, value|
+            tags[key] ||= value if key.match?(Trailer.config.auto_tag_fields) || Trailer.config.tag_fields.include?(key)
           end
         end
 
@@ -53,6 +54,7 @@ module Trailer
 
       # Put the keys in alphabetical order, with the event and resource first.
       sorted = { event: event, resource: resource_name }.merge(tags.sort_by { |key, _val| key.to_s }.to_h)
+      sorted.transform_keys!(&:to_sym)
       RequestStore.store[:trailer].write(sorted)
 
       result

data/lib/trailer/configuration.rb

@@ -14,8 +14,9 @@ module Trailer
                   :environment,
                   :storage,
                   :host_name,
-                  :service_name,
-                  :tag_fields
+                  :service_name
+
+    attr_reader :tag_fields
 
     # Constructor.
     def initialize
@@ -40,7 +41,12 @@ module Trailer
       # The storage backend class to use.
       @storage               = Trailer::Storage::CloudWatch
       # Optional - When tracing ActiveRecord instances, we can tag our trace with these fields explicitly.
-      @tag_fields            = %w[name]
+      @tag_fields            = %i[name]
+    end
+
+    # Make sure we store tag_fields as symbols for consistency.
+    def tag_fields=(fields)
+      @tag_fields = Array(fields).flatten.map(&:to_sym)
     end
   end
 end

data/lib/trailer/recorder.rb

@@ -13,13 +13,14 @@ module Trailer
     #
     # @param err [Exception] The exception to record.
     def add_exception(err)
-      write({ exception: err.class.name, message: err.message, trace: err.backtrace[0..9] })
+      write(tags.merge(exception: err.class.name, message: err.message, trace: Array(err.backtrace)[0..9]))
     end
 
     # Finish tracing, and flush storage.
     def finish
       storage.async.flush
       @trace_id = nil
+      @tags     = {}
     end
 
     # Create a new trace ID to link log entries.
@@ -28,6 +29,7 @@ module Trailer
 
       # See https://github.com/aws/aws-xray-sdk-ruby/blob/1869ca5/lib/aws-xray-sdk/model/segment.rb#L26-L30
       @trace_id = %(1-#{Time.now.to_i.to_s(16)}-#{SecureRandom.hex(12)})
+      @tags     = {} # This is used to accumulate tags in case we have an exception.
     end
 
     # Write the given hash to storage.
@@ -36,18 +38,19 @@ module Trailer
     def write(data)
       raise Trailer::Error, 'start() must be called before write()' if @trace_id.nil?
       raise Trailer::Error, 'data must be an instance of Hash' unless data.is_a?(Hash)
-      raise Trailer::Error, 'could not convert data to JSON' unless data.respond_to?(:to_json)
 
       # Include some standard tags.
       data[:environment]  ||= Trailer.config.environment
       data[:host_name]    ||= Trailer.config.host_name
       data[:service_name] ||= Trailer.config.service_name
+      data                  = data.compact.merge(trace_id: trace_id)
 
-      storage.async.write(data.compact.merge(trace_id: trace_id))
+      storage.async.write(data)
+      @tags.merge!(data)
     end
 
     private
 
-    attr_accessor :storage, :trace_id
+    attr_accessor :storage, :tags, :trace_id
   end
 end

data/lib/trailer/storage/cloud_watch.rb

@@ -16,16 +16,6 @@ module Trailer
         ensure_log_stream
       end
 
-      # Queues the given hash for writing to CloudWatch.
-      #
-      # @param data [Hash] A key-value hash of trace data to write to storage.
-      def write(data)
-        messages << {
-          timestamp: (Time.now.utc.to_f.round(3) * 1000).to_i,
-          message:   data&.to_json,
-        }.compact
-      end
-
       # Sends all of the queued messages to CloudWatch, and resets the messages queue.
       #
       # See https://stackoverflow.com/a/36901509
@@ -49,6 +39,18 @@ module Trailer
         retry
       end
 
+      # Queues the given hash for writing to CloudWatch.
+      #
+      # @param data [Hash] A key-value hash of trace data to write to storage.
+      def write(data)
+        return if data.empty?
+
+        messages << {
+          timestamp: (Time.now.utc.to_f.round(3) * 1000).to_i,
+          message:   data&.to_json,
+        }.compact
+      end
+
       private
 
       attr_accessor :client, :messages, :sequence_token

data/lib/trailer/storage/null.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trailer
+  module Storage
+    class Null
+      include Concurrent::Async
+
+      # Pretends to queue the given hash for writing.
+      #
+      # @param data [Hash] A key-value hash of trace data to write to storage.
+      def write(_data); end
+
+      # Pretends to flush the queued messages to the storage provider.
+      def flush; end
+    end
+  end
+end

data/lib/trailer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trailer
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trailer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Dave Perrett
@@ -34,7 +34,7 @@ cert_chain:
   3Um/SScB6alBpv/eTa/qPXa+S84pZDU6kFDasnH7GEl6jYlVxZbzpHUIvkDIOp5J
   6O1XOcLc39AfX5etu1WZ+wx3xUzux0oqS6rXcl63HmuKe8Son7RqJQ==
   -----END CERTIFICATE-----
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatchlogs
@@ -247,6 +247,7 @@ files:
 - lib/trailer/railtie.rb
 - lib/trailer/recorder.rb
 - lib/trailer/storage/cloud_watch.rb
+- lib/trailer/storage/null.rb
 - lib/trailer/utility.rb
 - lib/trailer/version.rb
 - trailer.gemspec